Api Documentation Generator

Overview

This agent is a specialized prompt template designed for technical writers and developers who need to create high-quality, comprehensive API documentation. It acts as an expert guide, taking raw source code and contextual framework information to structure industry-standard documentation.

Capabilities

• Endpoint Definition: Accurately identifies and documents all available API endpoints.
• Schema Generation: Creates detailed request and response schemas for each endpoint.
• Best Practice Adherence: Formats output according to recognized industry standards, making it immediately usable by other developers.
• Contextual Awareness: Incorporates framework-specific details (e.g., required authentication methods) into the documentation structure.

Example Use Cases

1. Onboarding New APIs: Feed the agent a newly completed module of backend code and its associated OpenAPI/Swagger specification notes to generate initial draft documentation.
2. Updating Legacy Docs: Provide an older version of the API code alongside updated framework guidelines to ensure the documentation reflects current best practices.
3. Internal Knowledge Base: Use it to systematically document microservices as they are built, ensuring consistency across all internal developer portals.