Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
tài liệu 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 mã 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 quy cách
Mở một OpenAPI Specification trong trình chỉnh sửa spec, như mô tả trong các phần sau:
Hình sau đây cho thấy quy cách của Petstore API mở trong trình chỉnh sửa quy cách: 
Như được làm nổi bật trong hình trước, trình chỉnh sửa thông số kỹ thuật cho phép bạn:
- Tạo Quy cách OpenAPI để mô hình hoá API của bạn bằng định dạng JSON hoặc YAML trong ngăn bên trái.
- Xem tài liệu API được tạo tự động trong ngăn bên phải.
- Xác thực quy cách theo tiêu chuẩn Quy cách OpenAPI khi bạn nhập.
- Lưu OpenAPI Specification hoặc đóng đặc tả và huỷ nội dung 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 đơn giản được dùng để biểu thị các cấu trúc dữ liệu đơn giản và mảng kết hợp. Để tìm hiểu thêm, hãy xem https://www.json.org.
YAML (YAML không phải là ngôn ngữ đánh dấu) là một tiêu chuẩn chuyển đổi tuần tự/biểu diễn dữ liệu cung cấp một cú pháp cũng cung cấp một cú pháp có thể được ánh xạ đến các 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 xem https://yaml.org.
Cả JSON và YAML đều có thể đọc được bằng máy, nhưng cũng dễ dàng để con người đọc và hiểu. Hình sau đây so sánh 2 đoạn trích ngắn trong cùng một OpenAPI Specification được viết bằng JSON và YAML:
Xác thực một quy cách
Trình chỉnh sửa đặc tả xác thực OpenAPI Specification của bạn dựa trên tiêu chuẩn OpenAPI Specification. Khi bạn nhập, nếu có lỗi trong OpenAPI Specification, trình chỉnh sửa thông số kỹ thuật sẽ cho thấy hộp thoại Lỗi ở đầu ngăn bên phải và cung cấp thêm thông tin về các lỗi cũng như số dòng liên quan để bạn có thể dễ dàng sửa lỗi.
Lưu quy cách
Để lưu một OpenAPI Specification, hãy nhấp vào Lưu trong thanh điều hướng trên cùng.
Nếu đây là lần đầu tiên lưu quy cách, 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à Untitled. Bạn có thể đổi tên sau.
Đóng quy cách
Để đóng một OpenAPI Specification mà không lưu nội dung chỉnh sửa, hãy nhấp vào Huỷ trong thanh điều hướng trên cùng. Bạn sẽ được đưa trở lại danh sách quy cách.