Swagger là gì

1. OpenAPI là gì

OpenAPI Specification là 1 trong những format biểu thị API dành riêng cho REST APIs. Một file OpenAPI chất nhận được chúng ta biểu đạt toàn cục API bao hàm cả

Cho phnghiền phần lớn endpoints (/web4_users) cùng phương pháp hoạt động vui chơi của mỗi endpoint (GET /web4_users, POST /web4_users)Các tsay mê 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 hệ, chứng chỉ, điều khoản áp dụng và phần đa lên tiếng khác

API specifications hoàn toàn có thể được viết bằng YAML hoặc JSON. Định dạng này dễ nhìn đọc, dễ nắm bắt cho toàn bộ cơ thể sử dụng lẫn ngôn từ máy tính

2. Swagger là gì

Swagger là một trong bộ cơ chế mã nguồn mngơi nghỉ để chế tạo OpenAPI specifications giúp chúng ta có thể thi công, tạo ra tư liệu và thực hiện REST APIs

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

3.1: Metadata

Mỗi OpenAPI specifications đã ban đầu với từ khóa openapi để knhị báo phiên phiên bản (VD: openapi: 3.0.0). Phiên phiên bản này đang có mang toàn bộ kết cấu của APIPhân info đang cất gần như đọc tin của API như: title, desscription (tùy chọn), version

title là tên API của bạnmô tả tìm kiếm là thông tin mở rộng về API của bạn. quý khách hàng rất có thể viết thành các dòng & cung cấp cú pháp Markdowninfo cũng hỗ trợ phần đa từ bỏ khóa về thông báo liên hệ, chứng chỉ, điều khoản sử dụng cùng đa số 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 đã hướng đẫn băng thông của VPS nhằm ta rất có thể test được API.


Bạn đang xem: Swagger là gì


Xem thêm: Bệnh Viện Đa Khoa Quốc Tế Vinmec Là Gì, Tập Đoàn Vingroup


Xem thêm: Nghĩa Của Từ Syllabus Là Gì, Nghĩa Của Từ Syllabus, Syllabus Là Gì, Nghĩa Của Từ Syllabus


Quý Khách có thể định nghĩa một hoặc các server
*
Tất cả băng thông API vẫn là đường dẫn tương đối của URL mà chúng ta định nghĩa. Hình ảnh bên yêu cầu là phần UI đã hiển thị ra

3.3: Paths

Đây là phần trung tâm của API. Ở phần này các bạn sẽ có mang hồ hết paths trong API của bạn cũng như phương thức, ttê mê số trong API

*

Phần này đang bắt đầu bởi tự khóa pathsSau đó là đến những path trong API (/web4_user/web4_userId)Tiếp cho là cách làm của API (GET, POST, DELETE, PUT ...)summary là phần mô tả bắt tắt của APIparameters: đang là mọi tđê mê số truyền vào API. quý khách hàng có thể phối tsi mê số required hay là không, biểu đạt nó (description) hoặc validate. Đặc biệt trong phần này. chúng ta có thể hướng dẫn và chỉ định 1 schema (đọc nôm mãng cầu là 1 trong Model) để hoàn toàn có thể khái niệm cho phần ttê mê số thông qua schema & $refresponse là phần trả về của hệ thống. quý khách rất có thể định nghĩa hồ hết HTTP code: 200, 404, 500 ... cùng với rất nhiều biểu thị mang lại từng ngôi trường hợp

3.4: Schema

quý khách hàng hoàn toàn có thể gọi nôm na đó là 1 Model. Phần này được knhị báo qua từ khóa component & schemas (Lưu ý: phần đa chỗ gọi mang đến schema này bắt buộc hướng dẫn và chỉ định đúng đắn đường truyền VD $ref: "#/components/schemas/User"

*

Tmê mệt số thứ nhất là tên của Model (User)Tiếp này sẽ là phần hình dạng định hình (object)Sau chính là phần nằm trong tính của Model này

Trên trên đây tôi đã chỉ dẫn sơ qua về hầu như tính năng của swagger mà lại tôi đã sử dụng trong dự ánCác chúng ta có thể vào liên kết nhằm hoàn toàn có thể viết API 1 cách nhân tiện độc nhất. Nó sẽ render UI ngay nhanh chóng mang đến bạn


Chuyên mục: Định Nghĩa