Agent Skills › meshery/meshery › api-doc

api-doc

GitHub

自动分析Meshery服务端Handler、路由及模型，生成REST API和GraphQL的标准文档，涵盖参数、鉴权、请求响应体及错误码。

.agents/skills/api-doc/SKILL.md meshery/meshery

Trigger Scenarios

需要为API端点生成或更新文档检查代码中的HTTP处理函数与路由映射

Install

npx skills add meshery/meshery --skill api-doc -g -y

More Options

Non-standard path

npx skills add https://github.com/meshery/meshery/tree/master/.agents/skills/api-doc -g -y

Use without installing

npx skills use meshery/meshery@api-doc

指定 Agent (Claude Code)

npx skills add meshery/meshery --skill api-doc -a claude-code -g -y

安装 repo 全部 skill

npx skills add meshery/meshery --all -g -y

预览 repo 内 skill

npx skills add meshery/meshery --list

SKILL.md

Frontmatter

{
    "name": "api-doc",
    "tools": [
        "search\/changes",
        "search\/codebase",
        "edit\/editFiles",
        "vscode\/extensions",
        "web\/fetch",
        "web\/githubRepo",
        "vscode\/getProjectSetupInfo",
        "vscode\/installExtension",
        "vscode\/newWorkspace",
        "vscode\/runCommand",
        "vscode\/openSimpleBrowser",
        "read\/problems",
        "execute\/getTerminalOutput",
        "execute\/runInTerminal",
        "read\/terminalLastCommand",
        "read\/terminalSelection",
        "execute\/createAndRunTask",
        "execute",
        "execute\/runTask",
        "execute\/runTests",
        "search",
        "search\/searchResults",
        "execute\/testFailure",
        "search\/usages",
        "vscode\/vscodeAPI",
        "github\/*",
        "memory"
    ],
    "description": "Document REST API endpoints and GraphQL operations in the Meshery server."
}

Skill: api-doc

Document REST API endpoints and GraphQL operations in the Meshery server.

Usage

Invoke this skill with a target handler file or directory:

/api-doc server/handlers/design_handler.go
/api-doc server/handlers/ (document all handlers)

Instructions

Read the target handler file(s) to identify all HTTP endpoint functions.
Read the router configuration in server/router/ to find URL paths and HTTP methods mapped to each handler.
Read the request/response model types in server/models/ referenced by the handlers.
Generate documentation in the format below.

Output Format

For each endpoint, document:

### `METHOD /api/path`

**Description**: Brief description of what the endpoint does.

**Authentication**: Required / Not required

**Parameters**:

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| id | path | string | yes | Resource identifier |
| page | query | int | no | Page number (default: 1) |

**Request Body** (if applicable):

```json
{
  "field": "type — description"
}
```

**Response** `200 OK`:

```json
{
  "field": "type — description"
}
```

**Error Responses**:

| Status | Description |
|--------|-------------|
| 400 | Invalid request body |
| 401 | Authentication required |
| 404 | Resource not found |

Guidelines

Derive descriptions from handler logic and comments — do not invent behavior
Include all query parameters, path parameters, and headers the handler reads
Document the actual JSON structure by reading the Go struct tags (json:"field_name")
Note any middleware applied (auth, rate limiting) visible in the router setup
For GraphQL, document queries and mutations with their input/output types
Group endpoints by resource type (designs, patterns, filters, connections, etc.)