OpenAPI là gì
Đặc tả để mô tả REST API
OpenAPI là đặc tả tiêu chuẩn để mô tả REST API, cho phép tự động hóa tài liệu và sinh mã.
Lợi ích của OpenAPI
- Tiêu chuẩn mô tả API thống nhất
- Tài liệu được tạo tự động
- Sinh mã client
- Xác thực yêu cầu và phản hồi
Các thành phần chính
- Info — siêu dữ liệu API
- Paths — điểm cuối và hoạt động
- Components — lược đồ tái sử dụng
- Security — phương thức xác thực
- Servers — URL cơ sở
Công cụ
- Swagger UI — tài liệu tương tác
- Swagger Editor — trình chỉnh sửa đặc tả
- OpenAPI Generator — sinh mã
- Redoc — tài liệu thay thế