Publikuj dokumentację API

Dokumentacja z kontraktu, jako witryna lub w Twoim portalu

Dokumentacja pisana ręcznie zostaje w tyle za API, które opisuje. Buduj ją z kontraktów: REST API i jego zdarzenia w jednej witrynie albo dokumentacja referencyjna wewnątrz portalu, który już masz.

Zbuduj dokumentację swojego API Zainstaluj API Genie

REST API i jego zdarzenia na jednej witrynieKontrakty OpenAPI i AsyncAPI w jednej witrynie, albo GraphQL i Protobuf, każde API pod własną ścieżką, zbudowane z tych samych plików, które sprawdza linter i mockuje serwer.
Część Twojego portaluStandardowe custom elements, które działają w zwykłym HTML-u, CMS-ie lub dowolnym frameworku, ostylowane tak, by wyglądały jak reszta Twojej strony.
Try it out, na stronieCzytelnicy wysyłają żądania prosto z dokumentacji, z kluczami API, uwierzytelnianiem Basic i Bearer, OAuth 2.0 lub OpenID Connect, i widzą odpowiedź.

REST API i jego zdarzenia, z jednego polecenia

apigenie-generator docs buduje jedną witrynę z kontraktów OpenAPI i AsyncAPI: strona na każde API, operację, schemat, kanał i wiadomość, prerenderowana, z wyszukiwaniem i Try it out. <apg-api-reference> renderuje tę samą dokumentację na Twojej stronie. Pobierz plik OpenAPI i plik AsyncAPI Carpet Express, żeby zbudować tę witrynę samodzielnie; usługa jest fikcyjna, a jej endpointy nie działają.

Dwie strony jednej witryny zbudowanej z kontraktów OpenAPI i AsyncAPI: operacja REST Create a shipment po lewej, operacja Kafka Publish shipment events po prawej.

Otwórz zrzut ekranu w pełnym rozmiarze

$ apigenie-generator docs carpet-express.openapi-31.yaml \
    carpet-express.asyncapi.yaml -o docs
$ cd docs && npm install && npm run build

Co obejmuje

Witryny z dokumentacjąKilka API w różnych standardach w jednej statycznej witrynie, prerenderowanej dla wyszukiwarek.
Komponenty dokumentacjiCała dokumentacja w jednym tagu albo własna strona złożona z jej części.
TłumaczeniaWyodrębnij teksty, przetłumacz je i opublikuj każdą wersję językową.
ChangelogiZmiany każdego API z jego historii Git, na osobnej stronie.
Podgląd na żywoEdytor renderuje dokumentację w trakcie edycji.
Pięć standardówOpenAPI, Swagger 2.0, AsyncAPI, GraphQL i Protobuf. Cztery z nich działają na żywo na stronie z przykładami.

Narzędzia, które to robią

Krok po kroku (przewodnik po angielsku)

Publish API documentation: Build a documentation site from your API descriptions, translate it, add the changelog of each API, or put a reference into a page of your own.

Witryna do hostowania albo elementy na stronę, którą masz

Serwuj witrynę z dowolnego hostingu statycznego albo wstaw <apg-api-reference> na własną stronę. Oba czytają pliki, które sprawdza linter.