Agent Docs Api Openapi
Skill Verified ActiveAgent skill for docs-api-openapi - invoke with $agent-docs-api-openapi
To automate and standardize the creation and maintenance of comprehensive OpenAPI/Swagger documentation for APIs, ensuring accuracy and adherence to specifications.
Features
- Create OpenAPI 3.0 specifications
- Document API endpoints with descriptions and examples
- Define request/response schemas
- Include authentication and security schemes
- Validate OpenAPI structure
Use Cases
- Generate initial OpenAPI documentation for a new API
- Update existing OpenAPI specifications with new endpoints or schema changes
- Ensure OpenAPI documentation adheres to best practices and standards
- Document legacy APIs for better integration and understanding
Non-Goals
- Generating code from OpenAPI specifications
- Testing API endpoints directly
- Managing API gateway configurations
- Creating interactive API documentation UIs
Workflow
- Analyze existing API routes and controllers
- Check for existing OpenAPI documentation files
- Create or update OpenAPI specification based on user request
- Document endpoints, schemas, and security
- Validate the OpenAPI specification syntax
- Complete API documentation process
Practices
- OpenAPI documentation
- API specification
- Code quality
Documentation
- info:Configuration & parameter referenceWhile the SKILL.md details constraints and behavior, there is no explicit reference to specific configuration parameters or their default values beyond the constraints defined for file paths and types.
Code Execution
- info:ValidationWhile the skill defines allowed file types and paths, there's no explicit mention of a schema validation library for input arguments or structured output handling.
Errors
- info:Actionable error messagesThe `on_error` hook provides a basic error message and a remediation suggestion, but it could be more specific about the root cause.
Practical Utility
- info:Edge casesWhile the skill defines constraints for file types and paths, it does not explicitly document failure modes (e.g., malformed input, dependency issues) with specific symptoms and recovery steps.
Installation
npx skills add ruvnet/rufloRuns the Vercel skills CLI (skills.sh) via npx — needs Node.js locally and at least one installed skills-compatible agent (Claude Code, Cursor, Codex, …). Assumes the repo follows the agentskills.io format.
Quality Score
VerifiedTrust Signals
Similar Extensions
Product Self Knowledge
100Stop and consult this skill whenever your response would include specific facts about Anthropic's products. Covers: Claude Code (how to install, Node.js requirements, platform/OS support, MCP server integration, configuration), Claude API (function calling/tool use, batch processing, SDK usage, rate limits, pricing, models, streaming), and Claude.ai (Pro vs Team vs Enterprise plans, feature limits). Trigger this even for coding tasks that use the Anthropic SDK, content creation mentioning Claude capabilities or pricing, or LLM provider comparisons. Any time you would otherwise rely on memory for Anthropic product details, verify here instead — your training data may be outdated or wrong.
Google Docs
100Interact with Google Docs - create documents, search by title, read content, and edit text. Use when user asks to: create a Google Doc, find a document, read doc content, add text to a doc, or replace text in a document. Lightweight alternative to full Google Workspace MCP server with standalone OAuth authentication.
Website Extraction Api
100Extract typed JSON from public website pages using a schema.
Aspnet Minimal Api Openapi
98Create ASP.NET Minimal API endpoints with proper OpenAPI documentation
Serialize Data Formats
97Serialize and deserialize data across common formats including JSON, XML, YAML, Protocol Buffers, MessagePack, and Apache Arrow/Parquet. Covers format selection criteria, encoding/decoding patterns, performance trade-offs, and interoperability considerations. Use when choosing a wire format for API communication, persisting structured data to disk, exchanging data between systems written in different languages, optimizing transfer size or parsing speed, or migrating from one serialization format to another.
Api Documenter
95API documentation specialist for OpenAPI/Swagger specifications. Use when documenting REST or GraphQL APIs.