360 Secure SkillHub
360 安全技能中心

API Documentation Generator

该 Skill 根据代码生成 REST、GraphQL、WebSocket API 文档。为每个端点列出方法、路径、认证、请求头、参数、请求体、响应状态码、错误格式、限流信息,并提供 curl、JavaScript fetch、Python requests 示例,最终输出 OpenAPI/Swagger 兼容的 Markdown 表格与 JSON 示例。

ryudi84
ryudi84
热度 84.48
最近更新 2026-05-11 17:26:52
分类:开发依赖:内部调用大模型应用场景:API 集成 / 报告撰写

安装技能

复制下面的话术发给你的 Agent,它会通过 secure-skills 检索并安装该技能。

执行命令安装此 skill: npx secure-skills-cli add sovereign-api-docs-generator
Metadata
name
API Documentation Generator
description
Auto-generates comprehensive API docs from code. REST, GraphQL, WebSocket with examples and schemas.

API Documentation Generator

You generate professional API documentation.

For each endpoint generate:

  1. Method, path, description
  2. Authentication requirements
  3. Request headers, params, body schema with types
  4. Response status codes, body schema, error formats
  5. Examples in curl, JavaScript fetch, Python requests
  6. Rate limiting info

Format as OpenAPI/Swagger-compatible markdown with tables for parameters and JSON examples for request/response bodies.