跳转到主要内容
此内容尚未提供您的语言版本,正在以英文显示。

Agent Docs Api Openapi

技能 已验证 活跃

Agent 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.

功能

  • Create OpenAPI 3.0 specifications
  • Document API endpoints with descriptions and examples
  • Define request/response schemas
  • Include authentication and security schemes
  • Validate OpenAPI structure

使用场景

  • 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

非目标

  • Generating code from OpenAPI specifications
  • Testing API endpoints directly
  • Managing API gateway configurations
  • Creating interactive API documentation UIs

工作流

  1. Analyze existing API routes and controllers
  2. Check for existing OpenAPI documentation files
  3. Create or update OpenAPI specification based on user request
  4. Document endpoints, schemas, and security
  5. Validate the OpenAPI specification syntax
  6. Complete API documentation process

实践

  • 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.

安装

npx skills add ruvnet/ruflo

通过 npx 运行 Vercel skills CLI(skills.sh)— 需要本地安装 Node.js,以及至少一个兼容 skills 的智能体(Claude Code、Cursor、Codex 等)。前提是仓库遵循 agentskills.io 格式。

质量评分

已验证
97 /100
1 day ago 分析

信任信号

最近提交1 day ago
星标50.2k
许可证MIT
状态
查看源代码

类似扩展

Product Self Knowledge

100

Stop 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.

技能
SeifBenayed

Google Docs

100

Interact 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.

技能
sanjay3290

Website Extraction Api

100

Extract typed JSON from public website pages using a schema.

技能
iterationlayer

Aspnet Minimal Api Openapi

98

Create ASP.NET Minimal API endpoints with proper OpenAPI documentation

技能
github

Serialize Data Formats

97

Serialize 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.

技能
pjt222

Api Documenter

95

API documentation specialist for OpenAPI/Swagger specifications. Use when documenting REST or GraphQL APIs.

技能
charon-fan