api-documentation
Generate API Documentation
API teams need accurate docs that match changing endpoints and examples. This skill helps Claude, Codex, and Claude Code create references, guides, and interactive documentation.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "api-documentation" from https://skillstore.io/skills/curiouslearner-api-documentation.md and its manifest at https://skillstore.io/api/skills/curiouslearner-api-documentation/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Your Agent should still show its plan and request any confirmation required by the security policy.
Agent-readable resources
Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.
Test it
Using "api-documentation". An OpenAPI specification for users, organizations, authentication, and billing endpoints.
Expected outcome:
- Endpoint reference grouped by resource.
- Authentication and token handling guide.
- Error, pagination, and rate limit sections.
- Language examples for common requests.
Using "api-documentation". Existing code comments for a TypeScript or Python service.
Expected outcome:
A structured draft with endpoint summaries, parameter descriptions, response notes, and missing documentation questions.
Using "api-documentation". A request to publish interactive docs for a developer portal.
Expected outcome:
A setup plan comparing documentation tools, required assets, hosting steps, and review checks before release.
Security Audit
SafeStatic findings were caused by Markdown code fences, example commands, placeholder API keys, and sample HTTP requests in SKILL.md. No evidence of prompt injection, credential exfiltration, obfuscated code, or automatic command execution was found.
Risk Factors
⚙️ External commands (87)
🌐 Network access (35)
🔑 Env variables (7)
Share & cite this report
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Copy report link
https://skillstore.io/skills/curiouslearner-api-documentation/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/curiouslearner-api-documentation?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/curiouslearner-api-documentation?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/curiouslearner-api-documentation/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/curiouslearner-api-documentation.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Academic citations (APA · BibTeX · CFF)
APA citation
CuriousLearner. (2026). api-documentation security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/curiouslearner-api-documentation/audits/8BibTeX citation
@techreport{curiouslearner-curiouslearner-api-documentation-2026,
author = {CuriousLearner},
title = {api-documentation security audit report (audit version 8)},
institution = {Skillstore},
year = {2026},
number = {8},
url = {https://skillstore.io/skills/curiouslearner-api-documentation/audits/8},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-documentation security audit report (audit version 8)"
version: "unspecified"
type: report
authors:
- name: "CuriousLearner"
date-released: "2026-07-05"
url: "https://skillstore.io/skills/curiouslearner-api-documentation/audits/8"
identifiers:
- type: other
value: "skillstore:curiouslearner-api-documentation:audit:8"
description: "Skillstore immutable audit report identifier"
Compare variants
3 installable variantsEach author remains a separate installable skill. The recommended variant is ranked by Skillstore evidence.
Why this variant is first
supercent-io-api-documentation
2026-08-21
sickn33-api-documentation
2026-08-21
curiouslearner-api-documentation
2026-08-21
Skillstore Score
Why this score Evidence Confidence: HighWhat You Can Build
Document a New API
Create reference pages, request examples, schemas, and status code notes from an OpenAPI specification.
Prepare Developer Guides
Turn endpoint details into getting started, authentication, error handling, pagination, and rate limit guides.
Launch Interactive Docs
Plan Swagger UI, Redoc, or Stoplight Elements documentation with sample requests and publishing steps.
Try These Prompts
Generate an API reference for this OpenAPI specification. Include endpoints, parameters, schemas, responses, and clear request examples.
Create getting started, authentication, error handling, pagination, and rate limit documentation for this API reference.
Design an interactive documentation setup for this API. Compare Swagger UI, Redoc, and Stoplight Elements for this project.
Create a publishing plan for Markdown, HTML, Postman collection, and SDK documentation outputs. Include validation and review steps.
Best Practices
- Keep the OpenAPI specification as the source of truth and regenerate docs after API changes.
- Replace placeholder tokens, domains, and examples before publishing.
- Test every sample request against a staging environment before release.
Avoid
- Publishing generated docs without checking authentication, error, and rate limit details.
- Mixing real secrets into examples or screenshots.
- Using interactive try-it-out features against production endpoints without limits.
Frequently Asked Questions
What inputs work best with this skill?
Can it create interactive documentation?
Does it verify live API behavior?
Can it help with SDK documentation?
Does it handle API keys safely?
Will it run setup commands automatically?
Developer Details
Author
CuriousLearnerLicense
MIT
Skillstore revision
r1
Version notice
The author did not declare a version.
Ref
02f077c174c5335e2f5d02ca15e77b70d9543e58
Maintenance freshness
7/22/2026
Usage
11 downloads · 337 views
File structure
📄 SKILL.md