openclaw 网盘下载
OpenClaw

技能详情(站内镜像,无评论)

首页 > 技能库 > API Documentation Generator

Generate comprehensive OpenAPI 3.0 specs, markdown reference docs, and SDK quickstarts from API endpoint descriptions with examples and error codes.

媒体与内容

许可证:MIT-0

MIT-0 ·免费使用、修改和重新分发。无需归因。

版本:v1.0.0

统计:⭐ 0 · 514 · 0 current installs · 0 all-time installs

0

安装量(当前) 0

🛡 VirusTotal :良性 · OpenClaw :良性

Package:1kalin/afrexai-api-docs

安全扫描(ClawHub)

  • VirusTotal :良性
  • OpenClaw :良性

OpenClaw 评估

The skill is an instruction-only API documentation generator and its declared requirements and instructions are coherent with that purpose.

目的

Name and SKILL.md describe generating OpenAPI, markdown docs, and quickstarts; the skill requests no binaries, env vars, or installs — this matches the stated purpose.

说明范围

Runtime instructions stay narrowly focused on producing OpenAPI specs, reference docs, and quickstarts. The only note is a suggestion to 'paste your route files or controller code for automatic extraction' — this is user-driven input, not an instruction to access system files or credentials autonomously.

安装机制

No install spec and no code files — instruction-only. That minimizes disk-write and remote-code risk.

证书

The skill requests no environment variables, credentials, or config paths; nothing disproportionate is required for generating docs.

持久

Defaults (not always: true) and normal autonomous invocation are used. There is no request for permanent presence or modification of other skills/configs.

综合结论

This appears internally consistent and low-risk, but follow these practical precautions before use: 1) Do not paste production secrets, API keys, or private certificates into the skill — only paste code or route descriptions you are comfortable sharing. 2) If you integrate this with CI/CD or a repo, grant the minimal scopes required and review any automation scripts. 3) Verify generated OpenAPI/spec examples before publishing (to avoid leaking…

安装(复制给龙虾 AI)

将下方整段复制到龙虾中文库对话中,由龙虾按 SKILL.md 完成安装。

请把本段交给龙虾中文库(龙虾 AI)执行:为本机安装 OpenClaw 技能「API Documentation Generator」。简介:Generate comprehensive OpenAPI 3.0 specs, markdown reference docs, and SDK quic…。
请 fetch 以下地址读取 SKILL.md 并按文档完成安装:https://raw.githubusercontent.com/openclaw/skills/refs/heads/main/skills/1kalin/afrexai-api-docs/SKILL.md
(来源:yingzhi8.cn 技能库)

SKILL.md

打开原始 SKILL.md(GitHub raw)

# API Documentation Generator

Generate production-ready API documentation from endpoint descriptions. Outputs OpenAPI 3.0, markdown reference docs, and SDK quickstart guides.

## Usage

Describe your API endpoints and this skill generates:

1. **OpenAPI 3.0 spec** — machine-readable, import into Swagger/Postman
2. **Markdown reference** — human-readable endpoint docs with examples
3. **SDK quickstart** — copy-paste integration guide for developers

## Instructions

When the user describes API endpoints (routes, methods, parameters, responses):

1. Generate a complete OpenAPI 3.0 YAML specification
2. Create markdown documentation with:
   - Authentication section
   - Each endpoint: method, path, description, parameters table, request/response examples
   - Error codes reference
   - Rate limiting notes
3. Generate a quickstart guide with curl examples and common language snippets (Python, JavaScript, Go)

### Output Format

```yaml
# openapi.yaml — full OpenAPI 3.0 spec
```

```markdown
# API Reference — human-readable docs
```

```markdown
# Quickstart Guide — integration examples
```

### Quality Standards
- Every endpoint must have request AND response examples
- Use realistic sample data, not "string" or "example"
- Include error responses (400, 401, 403, 404, 500)
- Document pagination, filtering, and sorting patterns
- Note breaking changes and versioning strategy

## Tips
- Paste your route files or controller code for automatic extraction
- Works with REST, GraphQL (schema-first), and gRPC (proto-first)
- Combine with CI/CD to auto-generate docs on every deploy

---

Built by [AfrexAI](https://afrexai-cto.github.io/context-packs/) — AI-powered business tools for teams that ship fast.