Tech Writer's Guide

API Documentation Tools

OpenAPI, GraphQL and source-code reference tooling: specification editors, linters, renderers, developer portals and SDK generators.

55 tech writing resources / page 1 of 2

Swagger

API Documentation Tools

The long-running family of OpenAPI tools, including Swagger UI, Editor and Codegen, for designing, documenting and consuming REST APIs.

swagger.io

Questions

Frequently asked questions

What counts as api documentation tools?

OpenAPI, GraphQL and source-code reference tooling: specification editors, linters, renderers, developer portals and SDK generators.

What are api documentation tools?

OpenAPI, GraphQL and source-code reference tooling: specification editors, linters, renderers, developer portals and SDK generators.

Docs-as-code or a help authoring tool?

Docs-as-code suits engineering teams who want docs in Git with the code. Help authoring tools suit writers producing large, reusable content sets with output to many formats. Many teams use both.