Building API Docs

Re:Building API Docs by cplli on Tuesday February 08, 2022 @01:22AM (#30255476)

I write the OpenAPI spec by hand as I haven’t found any tool to match my needs (nor is the API changing too often). And for the frontend to display the docs I couldn’t be any happier with https://stoplight.io/ (using their WebComponent for simplicity). I think I discovered this on the “APIs you won’t hate” podcast.

[ Parent | on HN ]

Re:Building API Docs by johnx123-up on Tuesday February 08, 2022 @01:41AM (#30255569)

Did you try https://github.com/Redocly/redoc ?

[ Parent | on HN ]

Re:Building API Docs by cplli on Tuesday February 08, 2022 @05:33AM (#30256856)

Actually used them for a short while. I didn't like the additional step in my pipeline to build the docs, also they don't/didn't offer an interactive option. Other than that it looked pretty nice.

[ Parent | on HN ]

Re:Building API Docs by wdb on Tuesday February 08, 2022 @08:09AM (#30257914)

Vaguely, I also think it's doesn't support all OpenAPI definition features

[ Parent | on HN ]