api_documentation
Generate API documentation from code in various languages and formats using predefined prompts for efficient integration into Cursor/Windsurf editors.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
code | Yes | 要生成文档的API代码 | |
format | Yes | 文档格式(markdown/html/jsdoc等) | |
language | Yes | 编程语言 |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"code": {
"description": "要生成文档的API代码",
"type": "string"
},
"format": {
"description": "文档格式(markdown/html/jsdoc等)",
"type": "string"
},
"language": {
"description": "编程语言",
"type": "string"
}
},
"required": [
"language",
"code",
"format"
],
"type": "object"
}