bee:writing-api-docs

Generate RESTful API reference documentation with endpoint, schema, and error details.

2|1|Updated Mar 3, 2026

Search Tags:#schema #error codes #rest api #api documentation #reference docs #developer documentation

Ready to run

npx skills add https://github.com/luanrodrigues/ia-frmwrk --skill bee-writing-api-docs

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bee:writing-api-docs
Source: https://github.com/luanrodrigues/ia-frmwrk/tree/main/tw-team/skills/writing-api-docs
Command: npx skills add https://github.com/luanrodrigues/ia-frmwrk --skill bee-writing-api-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a structured approach and essential patterns for writing comprehensive API reference documentation, ensuring clarity and consistency for developers.

Core Features & Use Cases

Endpoint Documentation: Define structure for HTTP methods, paths, parameters, and request/response schemas.
Error Documentation: Standardize the documentation of error codes, messages, and resolutions.
Use Case: When developing a new API endpoint, use this Skill to ensure all aspects—from parameters to potential errors—are clearly and consistently documented for consumers.

Quick Start

Use the bee:writing-api-docs skill to document the POST /users endpoint, including request parameters, a sample request body, and potential error responses.

Frequently Asked Questions about bee:writing-api-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I write API reference documentation for REST endpoints?▼

To write API reference documentation, define the HTTP methods, paths, parameters, and request/response schemas for each endpoint. This ensures developers understand how to interact with your RESTful conventions and explicit versioning.

What is the best way to document API error codes and messages?▼

Documenting API error codes requires standardizing the error messages and potential resolutions for each failure scenario. This provides developers with clear guidance on troubleshooting request failures and handling specific error conditions.

How do I structure request and response schemas in developer documentation?▼

Structuring request and response schemas in developer documentation involves explicitly defining parameter definitions and data types expected by the API. This ensures consumers can correctly format requests and parse responses according to established principles.

Does this approach to API documentation support explicit versioning?▼

Yes, this API documentation approach adheres to RESTful conventions and explicit versioning. It generates comprehensive reference docs that cover endpoint details and parameter definitions while maintaining clear version control for consumers.

When do I need to generate comprehensive API reference documentation?▼

You need comprehensive API reference documentation when developing a new API endpoint or exposing REST APIs to external developers. It ensures all aspects, from parameters to potential errors, are clearly and consistently documented for consumers.