Ngày đăng: Dec 1, 2016
Giờ đây, bạn có thể thêm tài liệu vào các phương thức và tài nguyên cho API được xây dựng của mình bằng Amazon API Gateway, giúp người tiêu dùng API dễ dàng hiểu API của bạn. Bạn có thể thêm tài liệu cho API của mình trực tiếp bằng bảng điều khiển API Gateway, CLI và SDK hoặc chỉ cần chỉ định API sử dụng thẻ tài liệu trong định nghĩa Swagger dành cho API. Bạn cũng có thể sử dụng lại tài liệu trên các đặc tính phổ biến của API. Ví dụ: bạn có thể tạo tài liệu lỗi tiêu chuẩn chỉ một lần và sử dụng tài liệu này trong nhiều phản hồi API mà không cần sao chép nội dung thực tế, giúp tạo tài liệu API của bạn nhanh hơn và loại bỏ các lỗi “sao chép-dán” có thể phát sinh với các chuỗi trùng lặp. Khi tài liệu của bạn được phát hành như một phần của giai đoạn API, bạn có thể xuất tài liệu này bằng tính năng xuất Swagger và cung cấp trong cổng thông tin dành cho nhà phát triển của mình.
API Gateway cung cấp cho bạn các luồng công việc độc lập dành cho định nghĩa API và tài liệu API. Điều này cho phép các nhà phát triển API và trình ghi kỹ thuật làm việc song song và nhập riêng Swagger của họ bằng cách sử dụng bảng điều khiển, CLI và SDK.
Để biết thêm chi tiết, hãy xem Tạo tài liệu cho API của API Gateway.