Phiên bản: Latest(v3.0) 🔥

API Search · Design · Test · Share

경로: APIM Console > Menu bên trái > Quản lý API > Nhấp vào tên API > Chi tiết API > Triển khai API
Swagger 미등록 시 선행 작업
1. Đặt đường dẫn nhập Swagger trong bước quản lý Swagger ở trên
2. Quay lại màn hình chi tiết API và nhấp vào Swagger 가져오기 sau đó nhấp vào Swagger 저장하기 để lưu
배포: Tiến hành triển khai trên màn hình chi tiết API.

경로: APIM Console > Menu bên trái > Tìm kiếm API
시나리오: Kiểm tra sự tồn tại của Endpoint API cần phát triển và quyết định sửa đổi/phát triển mới
- Tìm kiếm các trường Path, Method, Request/Response body, Tóm tắt, Mô tả, v.v.
- Nếu đã có Endpoint cần thiết: Sử dụng API hiện có mà không cần phát triển riêng
- Nếu cần thay đổi nhỏ như thêm một số trường: Thực hiện kiểm tra Endpoint hiện có, lưu và chia sẻ lịch sử để truyền đạt các yêu cầu thay đổi cho nhà phát triển
- Nếu hoàn toàn không có: Thiết kế/phát triển Endpoint API mới
주의사항
- ⚠️ Để tìm kiếm API, bạn cần phải APIM에 Swagger를 등록 관리.
- ⚠️ Tìm kiếm API sẽ dựa trên Swagger 정보 để truy xuất kết quả.

경로: APIM Console > Menu bên trái > Xác thực tài liệu API
시나리오: Khi phát triển mới hoặc thay đổi API hiện có, xác thực tuân thủ tiêu chuẩn tài liệu bằng "Xác thực định dạng API"
1. Trích xuất Swagger JSON do chương trình tạo ra trong môi trường địa phương/phát triển
2. Tải lên/nhập vào "Xác thực định dạng API" của APIM để thực hiện xác thực
3. Kiểm tra kết quả và nếu có vi phạm tiêu chuẩn, sửa đổi chương trình và cuối cùng vượt qua xác thực
주의사항
- ⚠️ Sau khi vượt qua xác thực trong môi trường xác thực, hãy tiến hành triển khai vào môi trường sản xuất.
- ⚠️ Như vậy, trong môi trường sản xuất, tài liệu sẽ được đăng ký/phát hành/quản lý dưới dạng tiêu chuẩn hóa.