API Reference Writer

Name: OpenModels
Creator: OpenModels
License: https://github.com/openmodelsrun/openmodels

MittelwritingMindestens 32K Kontext

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-docs reference documentation openapi developer-experience

Anwendungsfälle

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

Beispiel-Prompt

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.

Empfohlene Modelle

claude-sonnet-5-5 gpt-6-1-sol gemini-3-8-flash

Kompatible Werkzeuge

claude-codecursorkiroany

Modalitäten

Eingabe: text, code

→

Ausgabe: text, code