What it does

Organizes supplied endpoints, methods, parameters, request and response examples, authentication notes, and error behavior into an API documentation draft. It helps teams create a consistent starting point without replacing source inspection or executable tests.

How it works

Provide the relevant code, interface definitions, comments, schemas, examples, API version, deployment context, and documentation conventions. A developer should verify every endpoint and example against the running API before publishing or adding the draft to a release pipeline.

Example workflows

• Draft reference documentation for a new or changed endpoint.

• Turn schemas and code comments into developer-facing explanations.

• Prepare onboarding documentation for an internal service.