Tworzenie specyfikacji za pomocą edytora specyfikacji

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Tworzenie i weryfikowanie specyfikacji OpenAPI bez konieczności pisania kodu w edytorze specyfikacji.

Otwieranie edytora specyfikacji

Otwórz specyfikację OpenAPI w edytorze specyfikacji zgodnie z opisem w tych sekcjach:

Poniższy rysunek przedstawia specyfikację otwartego w edytorze specyfikacji interfejsu Petstore API:

Jak już wspomnieliśmy na poprzedniej ilustracji, edytor specyfikacji umożliwia:

  • W panelu po lewej stronie utwórz specyfikację OpenAPI, aby modelować interfejs API w formacie JSON lub YAML.
  • Wyświetl automatycznie wygenerowaną dokumentację interfejsu API w prawym panelu.
  • Sprawdzaj specyfikację pod kątem zgodności ze standardem OpenAPI podczas pisania.
  • Zapisz specyfikację OpenAPI lub zamknij specyfikację i anuluj zmiany.

Pomóż mi z użyciem formatu JSON i YAML

JSON (JavaScript Object Notation) to lekki format wymiany danych używany do reprezentowania prostych struktur danych i tablic powiązaniowych. Więcej informacji znajdziesz na stronie https://www.json.org.

YAML (YAML Ain't Markup Language) to standard serializacji/reprezentacji danych, który udostępnia składnię, którą można zmapować na struktury danych, takie jak listy, tablice powiązaniowe i skalary. Więcej informacji znajdziesz na stronie https://yaml.org.

Zarówno pliki JSON, jak i YY są zrozumiałe dla komputera, ale są też łatwe do odczytania i zrozumienia przez człowieka. Na tej ilustracji porównano 2 krótkie fragmenty tej samej specyfikacji OpenAPI napisanej w formacie JSON i YML:

JSON a YAML

Weryfikowanie specyfikacji

Edytor specyfikacji weryfikuje specyfikację OpenAPI pod kątem zgodności ze standardem OpenAPI. Jeśli specyfikacja OpenAPI wykryje błędy, edytor specyfikacji wyświetli okno Błąd u góry prawego panelu i wyświetli więcej informacji o błędach i powiązanych z nimi numerach wierszy, aby można było łatwo je poprawić.

Błędy

Zapisywanie specyfikacji

Aby zapisać specyfikację OpenAPI, kliknij Save (Zapisz) na górnym pasku nawigacyjnym.

Jeśli specyfikację zapisujesz po raz pierwszy, pojawi się prośba o podanie nazwy pliku. Jeśli nie określisz nazwy pliku, domyślnie zostanie użyta nazwa bez tytułu. Później możesz zmienić jej nazwę.

Zamykanie specyfikacji

Aby zamknąć specyfikację OpenAPI bez zapisywania zmian, kliknij Anuluj na górnym pasku nawigacyjnym. Wrócisz do listy specyfikacji.