OpenAPI na dokumentację Markdown
Konwertuj dokument OpenAPI lub Swagger na czytelną dokumentację referencyjną API w Markdown.
OpenAPI na dokumentację Markdown
Wklej dokument OpenAPI 3 lub Swagger 2 — JSON lub YAML — a to narzędzie zamieni go na dokumentację referencyjną API w Markdown, którą możesz wkleić bezpośrednio do README, strony wiki lub witryny dokumentacji. Każda operacja staje się własną sekcją, więc specyfikacja, którą mogła łatwo czytać tylko maszyna, staje się czymś, co kolegowie lub nowi integratorzy mogą szybko przeglądnąć.
Wyjście obejmuje spis treści z linkami do poszczególnych grup i punktów końcowych, tabelę parametrów (lub prostą listę) dla parametrów ścieżki, zapytania, nagłówka i plików cookie, wygenerowaną próbkę treści żądania, tabelę kodów odpowiedzi z ich opisami i przykładną odpowiedź z pierwszego pasującego schematu. Grupuj punkty końcowe według tagu lub pierwszego segmentu ich ścieżki, wybierz czy próbki żądań mają się renderować jako treść JSON czy gotowe do uruchomienia polecenie curl, i ustaw głębokość nagłówków punktów końcowych, aby wynik mógł być zagnieżdżony w istniejącym dokumencie. Jeden przełącznik obejmuje lub pomija przestarzałe punkty końcowe; inny wypisuje każdy schemat pod komponentami jako własną sekcję na koniec.
Odnośniki "$ref" w obrębie tego samego pliku są automatycznie śledzeni dla parametrów, treści żądań i odpowiedzi oraz schematów, tak że specyfikacja opierająca się na komponentach wciąż tworzy pełne tabele i próbki zamiast nagich łańcuchów $ref. Odnośniki do innego pliku lub adresu URL są pozostawiane bez zmian, ponieważ to narzędzie nigdy nie wysyła żądań poza przeglądarkę. Jeśli wygenerowany Markdown przekroczy limit wyjściowy narzędzia, zobaczysz jasny komunikat zamiast zawieszenia się karty.
Wszystko działa lokalnie w Twojej przeglądarce — Twoja specyfikacja API, która często opisuje systemy, które nie chcesz ujawniać, nigdy nie jest nigdzie wysyłana. Skopiuj Markdown, pobierz go jako plik .txt lub wyślij do innego narzędzia, aby kontynuować nad nim pracę.