Search

PythonReactSEOPDF
OpenClaw

Api Doc Generator

API Doc Generator

honestqiao0 source installs☆ 0 Repository stars

Installation

Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.

SkillHub CLI

skillhub install honestqiao/api-doc-generator

Inspect the source and compatibility requirements, then follow its installation steps.

Give your agent the source link and ask it to inspect instructions and dependencies before explaining the installation steps.

View source ↗Guides

Skill instructions

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 information

Source
github
Repository
openclaw/skills
Path
skills/honestqiao/api-doc-generator
Version
—
Commit
e811e8af8cf392538d19ce65eee0c7320c9fd9f2
Classification source
rules
Status
active
Visibility
public

These signals come from indexed source analysis and may lag behind changes. Check the current source files.

Extracted content

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": {...} }
      }
    }
  }
}
```

Related skills

OpenClaw

13-Day Sprint Method

galizki

Productivity system based on Maya calendar with 13 natural tones for project management and personal development

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.