搜索

PythonReactSEOPDF
OpenClaw

Api Doc Generator

API Doc Generator

honestqiao0 来源安装数☆ 0 仓库 Stars

安装与使用

请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。

SkillHub CLI

skillhub install honestqiao/api-doc-generator

打开来源仓库,查看说明和兼容环境后,按来源提供的命令或步骤安装。

将来源链接提供给你的 Agent,让它先读取说明、核对依赖,并向你说明将执行的安装步骤。

查看来源 ↗使用指南

技能说明

API Doc Generator

自动从代码生成 API 文档。

功能

  • 分析代码中的函数/方法签名
  • 自动提取参数和返回值类型
  • 生成 OpenAPI/Swagger 格式文档
  • 支持 Python、JavaScript、TypeScript、Go

触发词

  • "生成API文档"
  • "API文档"
  • "生成接口文档"
  • "openapi"
  • "swagger"

示例

用户: 帮我把这个Python函数生成API文档
助手: (使用此skill生成OpenAPI文档)

输出格式

{
  "openapi": "3.0.0",
  "info": { "title": "API", "version": "1.0.0" },
  "paths": {
    "/users": {
      "get": {
        "summary": "获取用户列表",
        "parameters": [...],
        "responses": { "200": {...} }
      }
    }
  }
}

来源信息

Source
github
Repository
openclaw/skills
Path
skills/honestqiao/api-doc-generator
Version
—
Commit
e811e8af8cf392538d19ce65eee0c7320c9fd9f2
分类来源
rules
状态
active
可见性
public

这些信息来自收录时的来源分析,可能滞后;使用前请核对最新来源文件。

来源内容

SKILL.md
# API Doc Generator

自动从代码生成 API 文档。

## 功能

- 分析代码中的函数/方法签名
- 自动提取参数和返回值类型
- 生成 OpenAPI/Swagger 格式文档
- 支持 Python、JavaScript、TypeScript、Go

## 触发词

- "生成API文档"
- "API文档"
- "生成接口文档"
- "openapi"
- "swagger"

## 示例

```
用户: 帮我把这个Python函数生成API文档
助手: (使用此skill生成OpenAPI文档)
```

## 输出格式

```json
{
  "openapi": "3.0.0",
  "info": { "title": "API", "version": "1.0.0" },
  "paths": {
    "/users": {
      "get": {
        "summary": "获取用户列表",
        "parameters": [...],
        "responses": { "200": {...} }
      }
    }
  }
}
```

相关技能

OpenClaw

1password

daggerkun007

Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.