langchain-ai/skills-benchmarks60 installs
api-docs
OpenAPI documentation and REST API design patterns
How do I install this agent skill?
npx skills add https://github.com/langchain-ai/skills-benchmarks --skill api-docsIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides documentation and standards for API design and OpenAPI specifications. No security considerations were identified during the analysis.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerpass
1 file scanned · No issues
What does this agent skill do?
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: 1.0.0
paths:
/users:
get:
summary: List users
parameters:
- name: limit
in: query
schema:
type: integer
default: 20
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
components:
schemas:
User:
type: object
required: [id, email]
properties:
id:
type: string
format: uuid
email:
type: string
format: email
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
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"details": [
{"field": "email", "message": "Invalid email format"}
]
}
}
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/langchain-ai/skills-benchmarks/api-docs">View api-docs on skillZs</a>