Content pfp
Content
@
0 reply
0 recast
2 reactions

greg pfp
greg
@gregfromstl
Best tools for generating REST API documentation?
8 replies
0 recast
25 reactions

atlasmoth pfp
atlasmoth
@osuji.eth
Do you mean generating like an open API spec from source code or generating user-friendly reference docs (like this https://docs.bsky.app/docs/api/app-bsky-actor-get-profiles ) from the API spec?
1 reply
0 recast
0 reaction

greg pfp
greg
@gregfromstl
Both
1 reply
0 recast
0 reaction

atlasmoth pfp
atlasmoth
@osuji.eth
For generating user-friendly docs from openapi spec, I always use Docusaurus and customize it heavily with their Doc generator plugin, a very great example of how to do this can be found here https://github.com/bluesky-social/bsky-docs
1 reply
0 recast
0 reaction

atlasmoth pfp
atlasmoth
@osuji.eth
As for generating the openapi spec itself, the easiest way is to annotate/decorate your code and then run a CLI tool to generate the spec, or you can manually write the spec.
0 reply
0 recast
0 reaction