Building API Docs

Re:Building API Docs by arcbyte on Monday February 07, 2022 @08:58PM (#30254079)

I've never found anything better than Enunciate. Works very well and it's guaranteed always up to date because it's a compile time artifact. I really like that all the documentation and code are in one place, next to each other, and have a higher chance of being true and up to date than any other method

[ Parent | on HN ]

Re:Building API Docs by mrbuzzinfrog on Monday February 07, 2022 @09:10PM (#30254151)

Isn't Enunciate only compatible for Java? I like that readme.com uses OpenAPI.

Any other alternatives to readme.com that look promising?

[ Parent | on HN ]

Re:Building API Docs by gkoberger on Monday February 07, 2022 @09:28PM (#30254263)

Heya! We (ReadMe) do indeed work well with Open API specs!

There's definitely alternatives if you're looking to just display docs. But we try to take it a step farther, and make APIs easy to use. We generate code samples in every language, have interactive try-it-now functionality, give you shareable links for API logs, have a nice clean `api` module in certain languages, have a mini getting started guide on each page, and more.

My email is in my profile if you want to talk more! (I'd be curious about any shortcomings you've found we can help out with!)

[ Parent | on HN ]