DEV Community

loading...

Discussion on: Writing really good technical documentation and guides for APIs and SDKs is NOT easy. Any tips out there?

Collapse
yloganathan profile image
Yuva

+1 for OpenAPI specification. We use swagger 2.0 UI for developer documentation. With a little bit of finagling, we were able to setup a contunious integration for documents. Any time openapi spec got changed, updated version of the API docs got generated and deployed automatically.

Example public facing api:

Example Swagger-UI where you could try the api directly

Setting up the dev document site is one of the topics in my list to write a detailed article about.