A place for developers to talk about building on Farcaster.

/dev

Best tools for generating REST API documentation?

NOTHING beats hand crafting your OpenAPI spec

Often devs go about this the wrong direction: looking for tools that generate OpenAPI/Swagger spec and docs from some code

Instead, start with hand crafting your OpenAPI spec and then use it to generate a client/sdk (ts/go/py/any language) and docs

stainlessapi.com

https://github.com/o-az
—
https://x.com/awkroot

Why's it the wrong direction to use tools tho? Just curious

because generating spec from code ends up being incomplete and tools ignore a bunch of openapi fields. If you read carefully a good openapi spec you’ll understand