Edytor
Edytuj API w formularzach, zachowaj swoje pliki
Edytuj OpenAPI i AsyncAPI w przeglądarce bez przeformatowania reszty pliku. Komentarze, kolejność kluczy i cudzysłowy zostają nietknięte.Edytor webowy jest dostępny już teraz. Wersje desktopowa i dla VS Code wychodzą z ich wydaniami 1.0.0.
- Diff Twojej zmiany, nie przeformatowanieZmiany z formularzy zachowują nietkniętą treść, w tym komentarze, kolejność kluczy, kotwice i cudzysłowy. Otwórz i zapisz bez edycji, a bajty będą identyczne.
- Referencje pozostają spójneŚledź referencje między plikami w otwartym folderze. Zmień nazwę komponentu, przenieś go, wyodrębnij lub wstaw, a edytor zaktualizuje referencje do niego.
- Zwykłe pliki, bez serweraPracuj na lokalnym folderze, bez konta, bazy danych i pliku projektu. Nic nie opuszcza Twojego komputera, chyba że wyślesz żądanie przez Try it out.
Formularz i diff, który po nim zostaje
Zmień podsumowanie operacji createShipment w jej formularzu i zapisz. Zmienia się tylko ta linia; otaczający YAML zachowuje formatowanie. Pobierz ten sam plik i wypróbuj tę zmianę samodzielnie.
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 isCo robi
- Formularze dla OpenAPI i AsyncAPIOperacje, parametry, ciała żądań, odpowiedzi, przykłady, serwery i zabezpieczenia dla OpenAPI 3.0 i 3.1; serwery, kanały, operacje, wiadomości oraz bindingi Kafka, AMQP, MQTT i WebSocket dla AsyncAPI 3.0. To, czego formularz nie modeluje, jest pokazane jako surowy YAML, nigdy porzucone.
- Wizualny edytor schematówBuduj JSON Schema jako drzewo, z przykładami generowanymi na jego podstawie i sprawdzanymi względem niego.
- Diagram przepływu wiadomościZobacz, które aplikacje wysyłają i odbierają które wiadomości przez które kanały, i edytuj przepływ na diagramie.
- Diagnostyka w trakcie pisaniaReguły lintera API Genie i Twoje własne zestawy reguł Spectral, z poprawkami jednym kliknięciem dla reguł, które mają bezpieczną poprawkę. Każdy problem prowadzi do swojego pola formularza i swojej linii.
- Podgląd dokumentacji na żywoDokumentacja aktualizuje się w trakcie edycji, renderowana przez komponenty webowe API Genie, z Try it out.
- Import i porównanieImportuj Swagger 2.0, AsyncAPI 2.x i kolekcje Postmana. Porównaj z ostatnio zapisaną wersją, z oceną jak w
apigenie diff, i wyeksportuj połączony pojedynczy plik.
Gdzie działa
Zacznij w przeglądarce już dziś. Wersje desktopowa i dla VS Code wychodzą z ich wydaniami 1.0.0; porównanie środowisk wymienia ich możliwości i ograniczenia.
- W przeglądarceOtwórz folder i zapisuj w miejscu w Chrome i Edge. Inne przeglądarki zapisują Twoje zmiany jako pliki do pobrania.
- Desktop, od 1.0.0Ten sam edytor we własnym oknie na macOS, Windows i Linuksie, z panelem Git, serwerem mocków uruchamianym z paska narzędzi i Try it dla operacji AsyncAPI na brokerach Kafka, AMQP, MQTT i WebSocket.
- VS Code, od 1.0.0Otwórz plik OpenAPI lub AsyncAPI w API Genie Editor. VS Code zachowuje historię cofania i zapis, a problemy edytora pokazują się w panelu Problems.