writing-api-docs

Official

Document APIs with clear endpoints and schemas.

AuthorLerianStudio
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Patterns and structure for writing API reference documentation including endpoint descriptions, request/response schemas, and error documentation.

Core Features & Use Cases

  • Endpoint documentation structure and examples
  • Field descriptions and data types reference
  • Error documentation and standard formats

Quick Start

Write API docs for a new endpoint: /writing-api-docs write-endpoint.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: writing-api-docs
Download link: https://github.com/LerianStudio/ring/archive/main.zip#writing-api-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.