Edytuj w formularzach

Edytuj API w formularzach, zachowaj swoje pliki

Autor dokumentacji poprawia jeden opis, a pull request przepisuje cały plik. Edytor pokazuje OpenAPI i AsyncAPI jako formularze i zmienia tylko te linie, które musi, więc diff to dokładnie ta zmiana.Zapisuje w miejscu w Chrome i Edge. W innych przeglądarkach upuść folder na stronę, a zmiany pobierzesz jako pliki.

Otwórz edytor webowy Czytaj przewodnik (po angielsku)

Product ownerzy i autorzy dokumentacji mogą zmieniać APIOperacje, schematy i przykłady edytuje się w formularzach, bez uczenia się YAML-a danego standardu. To, czego formularz nie modeluje, jest pokazane jako surowy YAML i zapisane z powrotem bez zmian.
Diffy, które pozostają małeKomentarze, kolejność kluczy, kotwice i cudzysłowy zostają takie, jakie były, więc zmianę z formularza recenzuje się jak zmianę ręczną.
Twoje pliki, na Twoim komputerzeEdytor pracuje na folderze na Twoim komputerze, bez konta i bez serwera. Nic nie jest nigdzie wysyłane, chyba że naciśniesz Try it out.

Formularz i diff, który po nim zostaje

Formularz na każdą operację, schemat, kanał i wiadomość, z problemami pod polami, do których należą, i YAML-em obok formularza. Tu zmieniono i zapisano podsumowanie operacji createShipment: plik różni się w tej jednej linii, a sekwencja flow nad nią, skalar blokowy pod nią i cudzysłowy zostają. Pobierz ten sam plik, żeby wykonać tę zmianę samodzielnie.

Edytor webowy: drzewo API po lewej, formularz operacji createShipment pośrodku z podsumowaniem zmienionym na Book a shipment i YAML po prawej z tą samą zmienioną linią.

Otwórz zrzut ekranu w pełnym rozmiarze

$ git diff carpet-express.openapi-31.yaml
@@ -195,7 +195,7 @@
           $ref: '#/components/responses/UnexpectedError'
     post:
       tags: [Shipments]
-      summary: Create a shipment
+      summary: Book a shipment
       description: |
         Books a shipment with the selected carrier service. The request body is

Co obejmuje

FormularzeOpenAPI 3.0 i 3.1 oraz AsyncAPI 3.0 z bindingami Kafka, AMQP, MQTT i WebSocket.
Edytor schematówJSON Schema jako drzewo, z przykładami generowanymi na jego podstawie.
RefaktoryzacjaZmiana nazwy, przenoszenie, wyodrębnianie i wstawianie, w każdym pliku folderu.
DiagnostykaReguły lintera i Twoje zestawy reguł Spectral, z szybkimi poprawkami.
ImportSwagger 2.0, AsyncAPI 2.x i kolekcje Postmana.
Trzy środowiskaPrzeglądarka już dziś; aplikacja desktopowa i rozszerzenie VS Code od ich wydań 1.0.0.

Narzędzie, które to robi

Edytor

Krok po kroku (przewodnik po angielsku)

Edit an API in forms: Open a folder of OpenAPI or AsyncAPI files in the editor, change them in forms, and review the change like any other.

Otwórz folder, wprowadź zmianę, przejrzyj diff

Edytor webowy otwiera Twój folder w Chrome lub Edge i zapisuje w miejscu; inne przeglądarki dostają zmiany jako pliki do pobrania. Bez konta, bez serwera. Aplikacja desktopowa i rozszerzenie VS Code dołączą z wydaniami 1.0.0.