api-documentation
API documentation workflow for generating OpenAPI specs, creating developer guides, and maintaining comprehensive API documentation.
75
63%
Does it follow best practices?
Impact
95%
1.11xAverage score across 3 eval scenarios
Passed
No findings from the security scan
Fix and improve this skill with Tessl
tessl review fix ./plugins/AI-Agents-Safe-Coding-Skills/skills/api-documentation/SKILL.mdThe canonical home for this skill is api-documentation in sickn33/agentic-awesome-skills
Evaluation results
100%
10%Create a Formal API Specification for PayStream
OpenAPI specification generation
All endpoints as paths
100%
100%
Request body schemas
100%
100%
Response schemas
100%
100%
Security scheme defined
100%
100%
Security applied to paths
100%
100%
Error responses documented
100%
100%
Rate limit information
100%
100%
Examples included
0%
100%
Parameters documented
100%
100%
API info section
100%
100%
85%
10%Create Developer Onboarding Documentation for the WeatherNow API
Developer guide and code examples
Getting started section
100%
100%
Authentication guide
100%
100%
Common patterns section
30%
40%
Troubleshooting section
60%
100%
FAQ section
0%
50%
curl examples
100%
100%
Programmatic code examples
100%
100%
Tutorial or step-by-step guide
60%
60%
Error handling guidance
100%
100%
Rate limit guidance
100%
100%
100%
10%Document the TaskFlow User Management API
Complete API documentation workflow
Auth scheme in OpenAPI
100%
100%
Paths with schemas
100%
100%
Error responses in OpenAPI
100%
100%
Examples in OpenAPI
100%
100%
Rate limits noted
100%
100%
Getting started section
100%
100%
Authentication guide
100%
100%
Troubleshooting section
100%
100%
FAQ section
0%
100%
curl examples
100%
100%
- Commit
57c135b
- Evaluated
- Agent
- Claude Code
- Model
- Claude Sonnet 4.6
Table of Contents
Is this your skill?
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.