#22 Tech Writer buduje dokumentację API, czyli Next.js, ReDoc i OpenAPI w akcji

35:57
 
Udostępnij
 

Manage episode 274737708 series 2508014
Stworzone przez Doc Developer, odkryte przez Player FM i naszą społeczność - prawa autorskie są własnością wydawcy, a nie Player FM, a dzwięk jest przesyłany bezpośrednio z ich serwerów. Naciśnij przycisk Subskrybuj, aby śledzić aktualizacje Player FM, lub wklej adres URL kanału do innych aplikacji podcastowych.

Next.js to framework Reacta, dzięki któremu można w elastyczny sposób tworzyć nowoczesne strony internetowe. Według rankingu na stronie staticgen.com, jest to również jeden z najpopularniejszych generatorów stron statycznych. Rozmawiamy o tym jak można połączyć Next.js z narzędziem ReDoc, żeby zbudować stronę z dokumentacją dla wielu API stworzonych przy pomocy specyfikacji OpenAPI. Zastanawiamy się też jak Next.js może nam się przydać kiedy piszemy dokumentację w standardzie DITA.

Informacje dodatkowe:

Next.js: https://nextjs.org/

React: https://pl.reactjs.org/

Static Site Generator: https://www.gatsbyjs.com/docs/glossary/static-site-generator/

StaticGen: https://www.staticgen.com/

Docusaurus: https://docusaurus.io/

Gatsby: https://www.gatsbyjs.com/

ReDoc: https://github.com/Redocly/redoc

OpenAPI: https://www.openapis.org/

Swagger UI: https://swagger.io/tools/swagger-ui/

swagger-ui-react: https://www.npmjs.com/package/swagger-ui-react

Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture

Wtyczki dla DITA OT: https://www.dita-ot.org/plugins

Wtyczka Swagger dla DITA OT: https://github.com/jason-fox/fox.jason.passthrough.swagger

23 odcinków