Ask HN: Best API Documentation Tools?

4 pointsthemast2 comments

Curious what people here are using for API documentation these days.

Looked into: - Swagger - Apidog - Mintlify - Docusaurus

It seems like the real challenge is keeping docs aligned with API changes rather than just generating them.

What’s working well for you?

View on HN

I am building docsalot to address this particular problem. It keeps the docs in sync with code

https://docsalot-docs.docsalot.dev/quickstart

We also have a full fledged web-client.

this is one of our customer

https://docs.backboard.io/api-reference/assistants/create

I know it is lame answer but I am very happy with Claude. I think it decide on mkdocs but it probably does not matter much.

My setup: There is bit of instruction in CLAUDE.md, with reference to full documenting.md startegy. If you are in python, consider doctest - documentation that doubles as unittest.

https://walnutgeek.github.io/lythonic/ https://github.com/walnutgeek/lythonic/

Reply on news.ycombinator.com