Tạo thông số kỹ thuật bằng trình chỉnh sửa thông số kỹ thuật

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 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 thông số kỹ thuật

Mở một 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 API Petstore đang mở trong trình chỉnh sửa thông số kỹ thuật:

Như đã nêu trong hình trước, trình chỉnh sửa thông số kỹ thuật 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 API được tạo tự động trong ngăn bên phải.
  • Xác thực thông số kỹ thuật theo 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 hoặc đóng thông số kỹ thuật và huỷ nội dung chỉnh sửa.

Giúp tôi về JSON và YAML

JSON (Ký hiệu đối tượng JavaScript) là một định dạng trao đổi dữ liệu nhẹ dùng để biểu thị các cấu trúc dữ liệu đơn giản và mảng liên kết. Để tìm hiểu thêm, hãy xem https://www.json.org.

YAML (YAML Ain't Markup Language – 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 cú pháp cũng có thể được liên kết với các cấu trúc dữ liệu, chẳng hạn như danh sách, mảng liên kết 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ễ đọc và dễ hiểu đối với con người. Hình sau đây so sánh hai đoạn trích ngắn từ cùng một Thông số kỹ thuật OpenAPI được viết bằng JSON và YAML:

JSON so với 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 ở đầu ngăn bên phải và cung cấp thêm thông tin về lỗi cũng như số dòng liên quan để bạn có thể dễ dàng khắc phục.

Lỗi

Lưu thông số kỹ thuật

Để lưu Thông số kỹ thuật OpenAPI, 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 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 mặc định sẽ là Không có tiêu đề. Bạn có thể đổi tên sau.

Đóng thông số kỹ thuật

Để đóng một Thông số kỹ thuật OpenAPI mà không lưu nội dung chỉnh sửa, 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.