OpenAPI
OpenAPI là lược đồ máy đọc được, mô tả mọi endpoint, tham số và phản hồi của một REST API, và từ đó có thể sinh ra client.
Chi tiết
API này công bố một tài liệu OpenAPI 3.1 kèm chỉ mục llms.txt, và đó là thứ cho phép một bộ sinh SDK, một collection Postman hay một framework tác nhân hiểu được bề mặt API mà không cần ai đọc văn xuôi trước. Tài liệu đó là nguồn sự thật cho hình dạng yêu cầu và mã trạng thái. Thay đổi hành vi được thông báo trên changelog trước khi phát hành, nên client sinh ra có thể được sinh lại có chủ đích thay vì phát hiện hỏng.
Còn gọi là
- swagger
- api schema