API Design & Documentation Generator
AI-powered API design and documentation assistant — generate RESTful/OpenAPI specs, write comprehensive API docs (guides, tutorials, reference), create mock servers, validate API designs, and produce SDK code snippets. Supports OpenAPI 3.0/3.1, AsyncAPI, GraphQL SDL, and major languages. Built for backend developers, API product managers, DevOps engineers, and technical writers who need to design, document, and ship APIs faster. Keywords: API documentation, OpenAPI spec, REST API design, API reference, developer portal, API guide, Swagger, AsyncAPI, GraphQL schema, API validation, mock server, SDK generation, API设计, 接口文档, OpenAPI, Swagger文档. Skill: API Design & Documentation Generator Owner: gechengling Summary: AI-powered API design and documentation assistant — generate RESTful/OpenAPI specs, write comprehensive API docs (guides, tutorials, reference), create mock servers, validate API designs, and produce SDK code snippets. Supports OpenAPI 3.0/3.1, AsyncAPI, GraphQL SDL, and major languages. Built for backend developers, API product managers, DevOps
Rank
62
Safety
84
Downloads
1.0k
Updated
Oct 11, 2026
Version
1.0.2
Source
CLAWHUB
About
What it does, and when to use it.
Capability contract not published. No trust telemetry is available yet. 1K downloads reported by the source. Last updated 10/11/2026.
Avoid when
- Contract metadata is missing or unavailable for deterministic execution.
Risk flags: missing_or_unavailable_contract, trust_data_unavailable, schema_references_missing
Public facts
Every fact links back to the source it came from.
- Vendor
- Clawhubvendor · observed Oct 11, 2026
- Protocol compatibility
- OpenClawcompatibility · observed Oct 11, 2026
- Adoption signal
- 1K downloadsadoption · observed Oct 11, 2026
- Latest release
- 1.0.2release · observed Sep 28, 2026
- Handshake status
- UNKNOWNsecurity
Install and run
Setup complexity: low.
clawhub skill install s17ewqc4f2s6gpcbm88hy7fgvn85kg1g:api-design-documentation- Setup complexity is LOW. This package is likely designed for quick installation with minimal external side-effects.
- Final validation: Expose the agent to a mock request payload inside a sandbox and trace the network egress before allowing access to real customer data.
Contract: missing
curl -s "https://www.xpersona.co/api/v1/agents/clawhub-gechengling-api-design-documentation/snapshot"
Run-check
$0.02 USD1 measured facts are behind this paywall: success rate and latency, uptime and estimated cost, when not to use it, how to call it, benchmark scores.
Agents pay $0.02 in USDC. A card payment is $0.50, the smallest a card allows.
Documentation
CLAWHUB
63,930 characters of source documentation, loaded on request.
Extracted files
3 files captured from the source.
SKILL.md
---
name: "API Design & Documentation Generator"
description: "AI-powered API design and documentation assistant — generate RESTful/OpenAPI specs, write comprehensive API docs (guides, tutorials, reference), create mock servers, validate API designs, and produce SDK code snippets. Supports OpenAPI 3.0/3.1, AsyncAPI, GraphQL SDL, and major languages. Built for backend developers, API product managers, DevOps engineers, and technical writers who need to design, document, and ship APIs faster. Keywords: API documentation, OpenAPI spec, REST API design, API reference, developer portal, API guide, Swagger, AsyncAPI, GraphQL schema, API validation, mock server, SDK generation, API设计, 接口文档, OpenAPI, Swagger文档."
version: "1.0.2"
---
# API Design & Documentation Generator
## Overview
Stop wrestling with API documentation. This AI assistant transforms your API concepts into production-ready specs, comprehensive docs, and working code snippets—in minutes, not days.
## Triggers
- 中文触发词:`API文档`、`接口文档`、`生成OpenAPI`、`API设计`、`Swagger文档`、`接口规范`、`API教程`、`GraphQL文档`
- English triggers: `API documentation`, `OpenAPI spec`, `REST API design`, `Swagger docs`, `API reference`, `generate API docs`, `API guide`, `mock server`
## Data Handling Note (read first / 前置声明)
API specs and examples frequently leak real data. Before pasting anything:
1. **Never include real credentials** — no production tokens, API keys, client
secrets, or connection strings. Use `<token>`, `${API_KEY}` placeholders.
2. **No real customer data in examples** — 保单号、身份证号、手机号、银行卡号、
姓名、地址 must be replaced with obvious synthetic values (`POL-000001`,
`138****0000`).
3. **Minimise the paste** — when you only need help with one endpoint, paste that
endpoint, not the whole 3,000-line spec.
4. **Saving artifacts** — generated specs, Postman collections and mock servers
are drafts. Show them to the user and get explicit confirmation before writing
to a repository, publishing to a portal, or sending to a third party.
5. **Internal-only APIs** — mark them as such in `info.description`; do not reuse
internal schemas in public docs without a review pass.
Code and specs in this document are reference material for you to run in your own
environment; this skill does not execute them on your behalf.
## Features
### 1. API Design Intelligence
- Generate OpenAPI 3.0/3.1 specs from descriptions or existing code
- Validate API designs against best practices (REST maturity, naming conventions)
- Suggest improvements for security, performance, and developer experience
- Convert between OpenAPI, AsyncAPI, and GraphQL SDL
**关于本表中的“危险示例”(重要)**
下表出现的 `DELETE /tasks/all` 等写法,是**评审反例**,用来说明“什么样的设计应该被
打回”。它不是可执行指令,本技能也不会替你发起任何请求。出现在此处的唯一目的是让你
在 code review 中识别并否决这类设计。
**关于全文的 URL、域名与凭证(重要)**
| 出现的形式 | 性质 | 处理 |
|---|---|---|
| `api.example.com`、`api.tasks.example.com` | RFC 2606 保留示例域名,不可解析 | 替换为你自己的域名 |
| `<token>`、`$TOKEN`、`${API_KEY}`_meta.json
{
"ownerId": "kn74e704j3ygjcygnpf02rdvd185js13",
"slug": "api-design-documentation",
"version": "1.0.2",
"publishedAt": 1790573135811
}skill-card.md
## Description: Helps design APIs and draft OpenAPI specifications, developer documentation, mock-server configurations, and SDK code examples. This skill is ready for commercial/non-commercial use. ## Publisher: [gechengling](https://clawhub.ai/user/gechengling) ### License/Terms of Use: MIT-0 ## Use Case: Backend developers, API product managers, DevOps engineers, and technical writers use this skill to draft and review API contracts, documentation, mock-server setups, and client examples. ### Deployment Geography for Use: Global ## Known Risks and Mitigations: Risk: API examples or pasted specifications may expose real credentials or customer data. Mitigation: Use placeholder credentials and synthetic data; check drafts for sensitive information before sharing. Risk: Generated requests, repository changes, or publication steps may be unsafe or inaccurate. Mitigation: Review generated artifacts and obtain explicit approval before running requests, writing to a repository, or publishing documentation. ## Reference(s): - [ClawHub skill listing](https://clawhub.ai/gechengling/skills/api-design-documentation) ## Skill Output: **Output Type(s):** [Markdown, Configuration, Code, Shell commands, Guidance] **Output Format:** [Markdown with OpenAPI YAML or JSON and code examples] **Output Parameters:** [1D] **Other Properties Related to Output:** [Drafts for review before execution or publication] ## Skill Version(s): 1.0.2 (source: ClawHub release and skill frontmatter) ## Ethical Considerations: Users should evaluate whether this skill is appropriate for their environment, review any generated or modified files before relying on them, and apply their organization's safety, security, and compliance requirements before deployment.
AionUi
Free, local, open-source 24/7 Cowork app and OpenClaw for Gemini CLI, Claude Code, Codex, OpenCode, Qwen Code, Goose CLI, Auggie, and more | 🌟 Star if you like it!
activepieces
AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents
cherry-studio
AI productivity studio with smart chat, autonomous agents, and 300+ assistants.
CopilotKit
The Frontend for Agents & Generative UI. React + Angular
Machine-readable data
The same record, as JSON, for agents and crawlers.
{
"facts": [
{
"factKey": "vendor",
"category": "vendor",
"label": "Vendor",
"value": "Clawhub",
"href": "https://clawhub.ai/gechengling/skills/api-design-documentation",
"sourceUrl": "https://clawhub.ai/gechengling/skills/api-design-documentation",
"sourceType": "profile",
"confidence": "medium",
"observedAt": "2026-10-11T19:38:43.026Z",
"isPublic": true
},
{
"factKey": "protocols",
"category": "compatibility",
"label": "Protocol compatibility",
"value": "OpenClaw",
"href": "https://www.xpersona.co/api/v1/agents/clawhub-gechengling-api-design-documentation/contract",
"sourceUrl": "https://www.xpersona.co/api/v1/agents/clawhub-gechengling-api-design-documentation/contract",
"sourceType": "contract",
"confidence": "medium",
"observedAt": "2026-10-11T19:38:43.026Z",
"isPublic": true
},
{
"factKey": "traction",
"category": "adoption",
"label": "Adoption signal",
"value": "1K downloads",
"href": "https://clawhub.ai/gechengling/api-design-documentation",
"sourceUrl": "https://clawhub.ai/gechengling/api-design-documentation",
"sourceType": "profile",
"confidence": "medium",
"observedAt": "2026-10-11T19:38:43.026Z",
"isPublic": true
},
{
"factKey": "latest_release",
"category": "release",
"label": "Latest release",
"value": "1.0.2",
"href": "https://clawhub.ai/gechengling/api-design-documentation",
"sourceUrl": "https://clawhub.ai/gechengling/api-design-documentation",
"sourceType": "release",
"confidence": "medium",
"observedAt": "2026-09-28T05:25:35.811Z",
"isPublic": true
},
{
"factKey": "handshake_status",
"category": "security",
"label": "Handshake status",
"value": "UNKNOWN",
"href": "https://www.xpersona.co/api/v1/agents/clawhub-gechengling-api-design-documentation/trust",
"sourceUrl": "https://www.xpersona.co/api/v1/agents/clawhub-gechengling-api-design-documentation/trust",
"sourceType": "trust",
"confidence": "medium",
"observedAt": null,
"isPublic": true
}
],
"events": [
{
"eventType": "release",
"title": "Release 1.0.2",
"description": "明示DELETE /tasks/all为评审反例而非可执行指令(TM1);新增URL/凭证/示例数据占位符性质对照表(E1);状态码表新增示例必要性列、破坏性变更表新增发布前必备动作列、标准表新增版本演进风险列;新增Example 6对外文档脱敏改造;生态动态更新至2026-09-28",
"href": "https://clawhub.ai/gechengling/api-design-documentation",
"sourceUrl": "https://clawhub.ai/gechengling/api-design-documentation",
"sourceType": "release",
"confidence": "medium",
"observedAt": "2026-09-28T05:25:35.811Z",
"isPublic": true
}
]
}Record generated Oct 11, 2026.
For crawlers
This page is free to read. The run-check above is the only paid part, and it answers HTTP 402 until it is paid. Everything else here is public.
- One record, as JSON: card, facts, snapshot, contract, trust.
- Every agent, one feed: /.well-known/ai-catalog.json
- What this site sells, and the price: /.well-known/x402
- Paid run-check: /api/v1/agents/clawhub-gechengling-api-design-documentation/run-check
