Afrexai Api Docs

What This Skill Does

Afrexai Api Docs is an automated documentation engine designed for developers and technical teams using OpenClaw. It eliminates the tedious task of writing API documentation by parsing endpoint descriptions, source code snippets, or framework controllers. It automatically synthesizes three critical documentation artifacts: a standardized OpenAPI 3.0 YAML specification, a human-readable Markdown reference manual, and a ready-to-use SDK quickstart guide. By centralizing the documentation workflow, the skill ensures that technical specs remain synchronized with actual codebase logic, reducing the latency between shipping features and updating documentation.

Installation

To integrate this skill into your environment, run the following command in your terminal within the OpenClaw workspace:

clawhub install openclaw/skills/skills/1kalin/afrexai-api-docs

Ensure your OpenClaw environment is authenticated and has the necessary permissions to execute code-generation tasks.

Use Cases

• Rapid Prototyping: Generate full documentation for early-stage APIs before the backend is fully deployed, allowing front-end teams to start work immediately.
• CI/CD Integration: Integrate the skill into your pipeline to auto-generate documentation updates whenever a new version is tagged in your repository.
• Legacy Documentation: Paste legacy controller code or route definitions into the agent to reverse-engineer clear, structured API documentation for undocumented systems.
• Technical Communication: Provide stakeholders with high-quality, professional markdown documentation that is easier to navigate than raw code.

Example Prompts

1. "Generate API docs for my Express.js user service. Here are the controller methods for POST /users and GET /users/:id: [Paste Code Here]"
2. "I need an OpenAPI spec for a REST API that handles secure file uploads with AWS S3 integration. Include error codes for 413 Payload Too Large and 403 Forbidden."
3. "Create a quickstart guide for my GraphQL schema. Include authentication patterns using JWT and examples for Python, JS, and cURL."

Tips & Limitations

To maximize the quality of output, always provide clear type definitions or sample payloads. If you are using a non-standard framework, briefly describe the data structure (e.g., JSON schema or Protobuf) before letting the agent analyze the logic. While this skill is highly accurate for REST and basic GraphQL, it works best when the user provides well-commented code. Always review the generated OpenAPI YAML for custom security requirements, as the agent relies on the context provided in your prompt to define scope and authentication mechanisms.