api-docs

OverviewHistoryStatsSecurity

npx skills add ...

Documentation

SKILL.md

OpenAPI documentation and REST API design patterns

npx skills add langchain-ai/skills-benchmarks --skill api-docs

Documentation

SKILL.mdView source

API Documentation Standards

Design and document RESTful APIs following industry standards.

OpenAPI Specification

Always document APIs using OpenAPI 3.0+:

openapi: 3.0.3
info:
  title: User API
  version:

REST Conventions

Use nouns for resources: /users, /orders
Use HTTP methods correctly: GET, POST, PUT, PATCH, DELETE
Return appropriate status codes: 200, 201, 400, 404, 500
Use pagination for lists: ?page=1&limit=20
Version your API: /v1/users

Error Responses

npx skills add langchain-ai/skills-benchmarks --skill api-docs

Documentation

SKILL.md

api-docs | SkillBundle

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid input",
    "details": [
      {"field": "email", "message": "Invalid email format"}
    ]
  }
}