1. OpenAPI là gì

OpenAPI Specification là 1 định hình mô tả API giành riêng cho REST APIs. Một file OpenAPI có thể chấp nhận được bạn trình bày toàn thể API bao hàm cả

Cho phnghiền phần nhiều endpoints (/users) với phương thức hoạt động của từng endpoint (GET /users, POST /users)Các tham số đầu vào và cổng output của từng hoạt độngPmùi hương thức xác thựcThông tin liên lạc, chứng từ, lao lý áp dụng với số đông đọc tin khác

API specifications có thể được viết bằng YAML hoặc JSON. Định dạng này đọc dễ, dễ dàng nắm bắt đến cả người dùng lẫn ngôn từ đồ vật tính

2. Swagger là gì

Swagger là 1 trong cỗ qui định mã nguồn msống để kiến tạo OpenAPI specifications góp bạn cũng có thể thiết kế, thành lập tài liệu cùng sử dụng REST APIs

3. Cấu trúc cơ bản

3.1: Metadata

Mỗi OpenAPI specifications sẽ bước đầu cùng với từ bỏ khóa openapi nhằm knhì báo phiên bạn dạng (VD: openapi: 3.0.0). Phiên phiên bản này đã định nghĩa tổng thể cấu trúc của APIPhân info đã chứa rất nhiều báo cáo của API như: title, desscription (tùy chọn), version

title là tên API của bạndescription là công bố không ngừng mở rộng về API của doanh nghiệp. Quý khách hàng rất có thể viết thành nhiều dòng và cung ứng cú pháp Markdowninfo cũng cung ứng phần đông trường đoản cú khóa về biết tin liên hệ, chứng từ, luật pháp thực hiện cùng phần lớn công bố khác

info: title: Sample API description: Optional multiline or single-line description in (http://commonmark.org/help/) or HTML. version: 0.1.9

3.2: Servers

Đây là phần sẽ hướng dẫn và chỉ định đường dẫn của server để ta rất có thể chạy thử được API.


Bạn đang xem: Tìm hiểu về swagger để viết api


Xem thêm: Hướng Dẫn Viết Shellcode Là Gì ? Kali Linux Căn Bản


Xem thêm: Microsoft Visio 2010,2013 + Key + Crack + Fullfree Seo Tools Crack


Quý khách hàng rất có thể có mang một hoặc nhiều server
*
Tất cả băng thông API vẫn là đường dẫn tương đối của URL nhưng mà bạn khái niệm. Ảnh mặt nên là phần UI vẫn hiển thị ra

3.3: Paths

Đây là phần trọng tâm của API. Ở phần này bạn sẽ tư tưởng hầu như paths trong API của người sử dụng cũng giống như phương thức, tđắm say số vào API

*

Phần này vẫn bắt đầu bởi từ bỏ khóa pathsSau sẽ là tới những path vào API (/user/userId)Tiếp cho là phương thức của API (GET, POST, DELETE, PUT ...)summary là phần biểu hiện bắt tắt của APIparameters: đã là đầy đủ tyêu thích số truyền vào API. Quý Khách hoàn toàn có thể mix tsay đắm số required hay là không, diễn đạt nó (description) hoặc validate. Đặc biệt vào phần này. bạn có thể chỉ định 1 schema (phát âm nôm mãng cầu là một trong Model) để có thể khái niệm bỏ phần tsi mê số thông qua schema & $refresponse là phần trả về của server. Bạn hoàn toàn có thể quan niệm số đông HTTP code: 200, 404, 500 ... cùng với phần đông biểu đạt đến từng ngôi trường hợp

3.4: Schema

quý khách hoàn toàn có thể phát âm nôm mãng cầu đây là 1 Model. Phần này được knhì báo qua tự khóa component & schemas (Lưu ý: phần đa khu vực Hotline mang lại schema này đề xuất hướng dẫn và chỉ định đúng mực đường dẫn VD $ref: "#/components/schemas/User"

*

Tđê mê số trước tiên là tên của Model (User)Tiếp này sẽ là phần mẫu mã format (object)Sau chính là phần thuộc tính của Model này

Trên đây mình đã lí giải sơ qua về đều kỹ năng của swagger nhưng tôi đã sử dụng trong dự ánCác chúng ta có thể vào link để có thể viết API một cách nhân thể độc nhất vô nhị. Nó đã render UI ngay mau chóng mang lại bạn