OpenAPI Specification (trước đây là Swagger Specification) là 01 tài liệu mô tả định dạng API dạng Rest API. 01 tập tin OpenAPI cho phép bạn mô tả toàn bộ API bao gồm:
- Các điểm truy cập( ví dụ /users) và các phương thức trên từng điểm truy cập (
GET /users
,POST /users
) - Tham số từng phương thức Input và Output.
- Các phương thức xác thực.
- Thông tin liên hệ, bản quyền, cách sử dụng và các thông tin khác.
Đặc tả API có thể được viết dạng file YAML hoặc JSON. Định dạng dễ đọc, dễ học với cả người hay máy tính. Toàn bộ đặc tả OpenAPI có thể dễ dàng tìm thấy tại: OpenAPI 3.0 Specification
Không có nhận xét nào:
Đăng nhận xét