Redocly

Redocly to platforma do dokumentacji API, która pomaga tworzyć profesjonalne portale dla deweloperów. Zaczynasz od pliku OpenAPI opisującego Twoje API, a Redocly przekształca go w czytelną, przejrzystą dokumentację z przykładami i interaktywnymi funkcjami.

Platforma obejmuje kilka produktów działających razem. Reunite to miejsce, gdzie zespoły piszą i przeglądają treści. Realm dostarcza końcową dokumentację Twoim użytkownikom. Redoc to silnik open-source, który renderuje dokumentację referencyjną API. Reef pomaga organizować i odkrywać wszystkie Twoje API w jednym katalogu.

W przeciwieństwie do podstawowych generatorów dokumentacji, Redocly oferuje kompletny portal dla deweloperów. Możesz dodawać przewodniki, samouczki i niestandardowe strony obok referencji API. Wszystko jest kontrolowane wersjami i aktualizuje się automatycznie po zmianie definicji API.

• Automatyczna dokumentacja API z plików OpenAPI

• Piękny układ z trzema panelami z nawigacją i przykładami

• Interaktywna konsola API do testowania punktów końcowych

• Opcje niestandardowego brandingu i stylizacji

• Przepływ pracy Git z automatycznymi aktualizacjami

• Obsługa wielu wersji API

• Zaawansowane wyszukiwanie z funkcjami AI

• Wsparcie Markdown dla przewodników i samouczków

• Narzędzia do współpracy zespołowej i przeglądów

• Wliczone hostowanie na niestandardowej domenie