michelabboud/api-documentation
guides/complete-guide/examples/skills/api-documentation/SKILL.md
Generate comprehensive API documentation following OpenAPI 3.0 and REST standards when creating or documenting APIs, endpoints, or web services
$ install --global
skillsauthnpx skillsauth add michelabboud/claude-code-helper api-documentationInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 25, 2026, 2:50 PM9.1s1 file scanned
SKILL.md
- name:
- api-documentation
- description:
- Generate comprehensive API documentation following OpenAPI 3.0 and REST standards when creating or documenting APIs, endpoints, or web services
API Documentation Skill
Generate professional API documentation following industry standards.
OpenAPI 3.0 Format
openapi: 3.0.0
info:
title: Your API Name
version: 1.0.0
description: Clear API description
servers:
- url: https://api.example.com/v1
paths:
/users:
get:
summary: List all users
parameters:
- name: limit
in: query
schema:
type: integer
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
components:
schemas:
User:
type: object
required:
- id
- email
properties:
id:
type: string
email:
type: string
Documentation Checklist
- [ ] Endpoint path and HTTP method
- [ ] Clear summary (1 line)
- [ ] Detailed description (2-3 sentences)
- [ ] All query/path/header parameters documented
- [ ] Request body schema (if applicable)
- [ ] All response status codes
- [ ] Response schemas
- [ ] Authentication requirements
- [ ] Rate limiting information
- [ ] Example requests and responses
Related Skills
michelabboud/skills/route-language-task
development
VerifiedTrustedCommunity
Score a coding task by complexity (1-10) and recommend the right model (haiku/sonnet/opus) before invoking a language agent. Holds the per-language rubric for all language/framework experts.
3SKILL.mdUpdated May 9, 2026
michelabboud/your-skill-name
tools
VerifiedTrustedCommunity
When the user asks about [TRIGGER WORDS], wants to [ACTION], or needs help with [TOPIC], use this skill to provide [CAPABILITY]
3SKILL.mdUpdated Apr 25, 2026
michelabboud/skills/update-check
tools
VerifiedTrustedCommunity
Check if your claude-code-helper installation is up to date and apply updates. Reads the local manifest and compares against the latest component-versions index on GitHub. Supports checking all components, a single component by name, and applying updates with automatic backup.
3SKILL.mdUpdated Apr 25, 2026
michelabboud/skills/testing
testing
VerifiedTrustedCommunity
Comprehensive testing skill covering TDD, E2E, BDD, contract testing, mutation testing, and visual regression. Use when writing tests, designing test strategy, adding test coverage, fixing flaky tests, mocking services, setting up testing frameworks, or any testing task. Triggers on 'write tests', 'add test coverage', 'test strategy', 'fix flaky test', 'mock', 'E2E test', 'unit test', 'integration test'.
3SKILL.mdUpdated Apr 25, 2026