import_openapi
Import OpenAPI data into Apifox to generate API documentation. Specify input as JSON string, file path, or directory.
Instructions
导入OpenAPI数据到Apifox,在用户明确生成api文档时使用,使用前读取规则或用户指定的项目ID和API密钥,可导入json字符串/包含json文档的目录/json文件
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"input": "<input>",
"projectId": "<projectId>",
"apiKey": "<apiKey>"
},
"name": "import_openapi"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| input | Yes | JSON 格式 OpenAPI 数据字符串,或接口文档json文件绝对路径(示例"file#[路径]"),或包含json文件的目录绝对路径(示例"dir#[路径]")。注意路径可能有盘符 | |
| apiKey | Yes | Apifox API密钥 | |
| projectId | Yes | Apifox项目ID |