cd ~/open-source/

chrille@linux:~$ apt show swagger-ui

Swagger UI

Swagger UI tar dina OpenAPI-specifikationer och gör dem till en interaktiv API-dokumentation direkt i webbläsaren. Du kan visa endpoints, parametrar och prova anrop utan att behöva lämna sidan. Det gör det enkelt för både utvecklare och intressenter att förstå vad ditt API faktiskt gör.

Projektsidan för Swagger UI
Projektets egen sida, som den såg ut vid importen.

Swagger UI låter dig presentera ditt API på ett sätt som både utvecklare och intressenter kan förstå. Du pekar på en OpenAPI-fil, och verktyget genererar en sajt där besökare kan läsa om varje endpoint, se exempel och prova anrop direkt. Det passar dig som vill ha levande API-docs som alltid speglar den aktuella specifikationen. Du kan anpassa utseendet och bädda in det i din egen sajt eller portal. Det har funnits länge och är brett stött. Du kan peka på en OpenAPI-fil i JSON eller YAML, och besökare får se parametrar, svarskoder, exempel och autentiseringskrav tydligt. Det går att bädda in i en befintlig sajt eller köra som en fristående docs-sajt, och det har stöd för de flesta versioner av OpenAPI.