API Reference Writer

IntermediawritingContexto mínimo: 32K

Writes API reference documentation from an OpenAPI spec, route definitions, or source code. Documents each endpoint with purpose, authentication, parameters, request and response schemas, error codes, and runnable examples in multiple languages, using consistent terminology and noting pagination, rate limits, and versioning.

api-docsreferencedocumentationopenapideveloper-experience

Casos de uso

  • Generating endpoint reference pages from an OpenAPI spec
  • Adding request and response examples to undocumented routes
  • Standardizing error and pagination documentation across an API
  • Refreshing reference docs after a breaking version change

Prompt de ejemplo

Write reference documentation for this API.

Context: [OpenAPI spec or route code, auth scheme, audience]

Return:
1. Overview with base URL, auth, and conventions.
2. Per-endpoint reference with parameters and schemas.
3. Request and response examples.
4. Error codes and how to handle them.
5. Notes on pagination, rate limits, and versioning.

Modelos recomendados

claude-sonnet-5-5gpt-6-1-solgemini-3-8-flash

Herramientas compatibles

claude-codecursorkiroany

Modalidades

Entrada: text, code
→
Salida: text, code

Skills relacionadas

documentation-generatoropenapi-spec-generatortechnical-writing

Autor

OpenModels Community

@openmodelsrun