cd ~/open-source/

chrille@linux:~$ apt show redoc

Redoc

Redoc skapar snygg och responsiv API-dokumentation från OpenAPI-specifikationer. Du får en ren layout som fungerar bra både på skrivbord och mobil, vilket gör den lätt att läsa och navigera i. Det passar dig som vill ha API-docs som ser bra ut utan att behöva designa dem själv.

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

Redoc läser din OpenAPI-fil och bygger en dokumentationssajt med fokus på läsbarhet och struktur. Du får en sidopanel med navigation, tydliga exempel och stöd för olika teman. Det passar dig som vill ha API-docs som ser bra ut utan att behöva designa dem själv. Sajten är responsiv och fungerar bra för användare som besöker den från telefonen. Du kan hosta den själv eller bädda in den i en befintlig sajt. Det är ett pålitligt val för publik dokumentation. Du kan välja mellan olika layouter, bädda in panelen i din egen sajt och låta användarna se exempel i flera språk. Det passar särskilt bra för publik API-dokumentation där du vill att dokumentationen ska se professionell ut utan att lägga tid på design.