api-documentation

Create comprehensive API documentation for developers. Use when documenting REST APIs, GraphQL schemas, or SDK methods. Handles OpenAPI/Swagger, interactive docs, examples, and API reference guides.

1.28x

Quality

82%

Does it follow best practices?

Impact

94%

1.28x

Average score across 3 eval scenarios

Securityby

Passed

No known issues

Evaluation results

100%

OpenAPI Specification for a Fitness Tracking API

OpenAPI spec structure and conventions

Criteria

Without context

With context

OpenAPI version

60%

100%

Multiple servers

100%

bearerAuth security scheme

100%

Global security applied

100%

$ref for schemas

100%

$ref for error responses

100%

Format specifiers

100%

Validation constraints

100%

Required arrays

100%

Error response schemas

100%

Success and error responses

100%

No vague descriptions

100%

No real credentials

100%

92%

27%

Developer Documentation for the Notivio Notification API

Documentation directory structure and developer guides

Criteria

Without context

With context

docs/README.md present

100%

docs/getting-started.md present

100%

docs/authentication.md present

100%

api-reference/ subfolder

100%

guides/ subfolder with 3 files

100%

examples/curl.md present

100%

examples/javascript.md present

100%

examples/python.md present

100%

openapi.yaml present

100%

Auth token acquisition example

100%

Auth token usage example

100%

Rate limit values documented

X-RateLimit-Remaining header

100%

Pagination params documented

50%

100%

Pagination response shape

50%

100%

Standard error codes table

100%

No real credentials in examples

100%

No vague descriptions

100%

90%

34%

Add Interactive API Documentation to an Express/TypeScript Service

Swagger UI setup and JSDoc annotations in Express/TypeScript

Criteria

Without context

With context

swagger-ui-express import

100%

yamljs import

100%

YAML.load() call

100%

/api-docs route

100%

topbar hidden via customCss

customSiteTitle set

100%

@swagger JSDoc on route

100%

JSDoc includes summary and tags

100%

JSDoc includes requestBody or parameters

100%

JSDoc documents responses

100%

Success and error responses in JSDoc

100%

No real credentials

100%

Repository: supercent-io/skills-template
Commit: c033769

Evaluated: 28 days ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

OpenAPI Specification for a Fitness Tracking API Developer Documentation for the Notivio Notification API Add Interactive API Documentation to an Express/TypeScript Service

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.