Doc Generator

从源码生成准确、完整的 API 文档和技术说明。Use when creating or updating API docs, generating endpoint documentation, or when users mention API docs, endpoints, or documentation.

lhfer d1d2a99 2 files · 2.2 KB Updated

File contents

API Documentation Generator Skill / API 文档技能

生成内容

  • OpenAPI / Swagger 文档
  • endpoint 文档
  • SDK 示例
  • 集成指南
  • 错误码说明
  • 鉴权说明

每个 endpoint 需要包含

输出尽量包含:

  • Description(说明)
  • Parameters(参数)
  • Response
  • Errors
  • cURL / JavaScript / Python 示例

要求:

  • 文档结构清晰
  • 示例可复制
  • 与源码保持一致

lhfer/claude-howto-zh-cn/tree/main/03-skills/doc-generator commit d1d2a99d82

Frequently asked questions

npx skillmds@latest add lhfer/doc-generator