Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Tạo và xác thực Thông số kỹ thuật OpenAPI mà không cần viết bất kỳ mã nào bằng trình chỉnh sửa thông số kỹ thuật.
Truy cập vào trình chỉnh sửa thông số kỹ thuật
Mở thông số kỹ thuật OpenAPI trong trình chỉnh sửa thông số kỹ thuật, như mô tả trong các phần sau:
Hình sau đây cho thấy thông số kỹ thuật của Petstore API mở trong trình chỉnh sửa thông số:
Như được đánh dấu trong hình trước, trình chỉnh sửa thông số cho phép bạn:
- Tạo Thông số kỹ thuật OpenAPI để lập mô hình API bằng định dạng JSON hoặc YAML trong ngăn bên trái.
- Xem tài liệu về API được tạo tự động trong ngăn bên phải.
- Xác thực thông số kỹ thuật của bạn dựa trên tiêu chuẩn Thông số kỹ thuật OpenAPI khi bạn nhập.
- Lưu thông số kỹ thuật OpenAPI của bạn hoặc đóng thông số kỹ thuật đó và hủy chỉnh sửa.
Giúp tôi về JSON và YAML
JSON (JavaScript Object Notation) là một định dạng trao đổi dữ liệu gọn nhẹ dùng để thể hiện cấu trúc dữ liệu đơn giản và các mảng kết hợp. Để tìm hiểu thêm, hãy xem https://www.json.org.
YAML (Ngôn ngữ đánh dấu YAML Ain't) là một tiêu chuẩn biểu diễn/chuyển đổi tuần tự dữ liệu cung cấp cú pháp cũng cung cấp cú pháp có thể được ánh xạ đến cấu trúc dữ liệu, chẳng hạn như danh sách, mảng kết hợp và đại lượng vô hướng. Để tìm hiểu thêm, hãy truy cập vào https://yaml.org.
Cả JSON và YAML đều có thể đọc được bằng máy nhưng cũng dễ đọc và dễ hiểu đối với người dùng. Hình sau đây so sánh hai phần trích dẫn ngắn từ cùng một Thông số kỹ thuật OpenAPI được viết bằng JSON và YAML:
Xác thực thông số kỹ thuật
Trình chỉnh sửa thông số kỹ thuật xác thực Thông số kỹ thuật OpenAPI của bạn theo tiêu chuẩn Thông số kỹ thuật OpenAPI. Khi bạn nhập, nếu có lỗi trong Thông số kỹ thuật OpenAPI, trình chỉnh sửa thông số kỹ thuật sẽ hiển thị hộp thoại Lỗi ở phía trên cùng của ngăn bên phải và cung cấp thêm thông tin về lỗi và số dòng liên quan để bạn có thể dễ dàng sửa lỗi.
Lưu thông số kỹ thuật
Để lưu một Thông số kỹ thuật OpenAPI, hãy nhấp vào Save (Lưu) ở thanh điều hướng trên cùng.
Nếu đây là lần đầu tiên bạn lưu thông số kỹ thuật, bạn sẽ được nhắc nhập tên tệp. Nếu bạn không chỉ định tên tệp, tên tệp sẽ mặc định là Không có tiêu đề. Sau này, bạn có thể đổi tên tài khoản.
Đóng phần thông số kỹ thuật
Để đóng một Thông số kỹ thuật OpenAPI mà không lưu các nội dung chỉnh sửa của bạn, hãy nhấp vào Cancel (Huỷ) trong thanh điều hướng trên cùng. Bạn sẽ được đưa trở lại danh sách thông số kỹ thuật.