DocumentaciónPrincipiante

Generador de documentación de API

Genere documentación de API exhaustiva a partir de especificaciones de endpoints.

Resumen

Esta plantilla le ayuda a generar documentación detallada de API, incluyendo formatos de solicitud/respuesta, ejemplos y códigos de error. Es ideal para APIs REST y puede adaptarse para GraphQL.

Cuándo Usar

Use this when documenting new API endpoints, updating existing documentation, or creating API reference guides for your team or external developers.

Personalizar Plantilla

Complete las variables

Http Method*

The HTTP method for this endpoint

Endpoint Path*

The URL path including parameters

Description*

What this endpoint does

Auth Required*

Authentication requirements

Request Details

Additional details about the request (body schema, query params, etc.)