bee:writing-api-docs

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.