Tworzenie specyfikacji za pomocą edytora specyfikacji

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

tworzenie i weryfikowanie specyfikacji OpenAPI bez pisania kodu za pomocą edytora specyfikacji.

Otwieranie edytora specyfikacji

Otwórz specyfikację OpenAPI w edytorze specyfikacji w sposób opisany w następujących sekcjach:

Na poniższym rysunku widać specyfikację interfejsu Petstore API otwartą w edytorze specyfikacji:

Jak widać na poprzednim rysunku, edytor specyfikacji umożliwia:

  • Utwórz specyfikację OpenAPI, aby modelować interfejs API w formacie JSON lub YAML w lewym okienku.
  • W prawym panelu wyświetla się automatycznie wygenerowana dokumentacja interfejsu API.
  • Weryfikuj specyfikację pod kątem zgodności ze specyfikacją OpenAPI w miarę jej tworzenia.
  • Zapisz specyfikację OpenAPI lub zamknij specyfikację i anuluj zmiany.

Pomoc dotycząca plików JSON i YAML

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

YAML (YAML Ain't Markup Language) to standard serializacji/reprezentacji danych, który zapewnia składnię, która może być mapowana na struktury danych, takie jak listy, tablice skojarzeniowe i skalary. Więcej informacji znajdziesz na stronie https://yaml.org.

Formaty JSON i YAML są czytelne dla maszyn, ale też łatwe do odczytania i zrozumienia przez ludzi. Na rysunku poniżej porównano 2 krótkie fragmenty tej samej specyfikacji OpenAPI w formacie JSON i YAML:

JSON a YAML

Sprawdzanie specyfikacji

Edytor specyfikacji sprawdza specyfikację OpenAPI pod kątem zgodności ze standardem OpenAPI. Jeśli podczas pisania w specyfikacji OpenAPI pojawią się błędy, edytor specyfikacji wyświetli okno Błąd w górnej części panelu po prawej stronie. Znajdziesz w nim więcej informacji o błędach i powiązanych z nimi numerach wierszy, dzięki czemu możesz je łatwo poprawić.

Błędy

Zapisywanie specyfikacji

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

Jeśli zapisujesz specyfikację po raz pierwszy, pojawi się prośba o podanie nazwy pliku. Jeśli nie podasz nazwy pliku, zostanie ona domyślnie ustawiona na Bez tytułu. Możesz ją przemianować później.

Zamknij specyfikację

Aby zamknąć specyfikację OpenAPI bez zapisywania zmian, na górnym pasku nawigacyjnym kliknij Anuluj. Otworzy się ponownie lista specyfikacji.