Rechercher

PythonReactSEOPDF
OpenClaw

Api Doc Generator

API Doc Generator

honestqiao0 installations selon la source☆ 0 Étoiles du dépôt

Installation

Suivez les instructions du dépôt pour votre agent. Consultez les fichiers et dépendances avant l’installation.

SkillHub CLI

skillhub install honestqiao/api-doc-generator

Examinez la source et la compatibilité, puis suivez les étapes d’installation.

Donnez le lien à votre agent et demandez-lui d’examiner instructions et dépendances avant d’expliquer les étapes.

Voir la source ↗Guides

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

Informations sur la source

Source
github
Repository
openclaw/skills
Path
skills/honestqiao/api-doc-generator
Version
—
Commit
e811e8af8cf392538d19ce65eee0c7320c9fd9f2
Source de classification
rules
Statut
active
Visibilité
public

Ces informations proviennent de l’analyse indexée et peuvent être anciennes. Vérifiez les fichiers actuels.

Contenu extrait

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

Skills associés

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.