WMS_MAIN/docs/api-doc-update-spec.example.json
2026-04-16 20:00:01 +08:00

56 lines
1.1 KiB
JSON

{
"docName": "<system|qimen|gateway>",
"docMeta": {
"updatedAt": "<YYYY-MM-DD>",
"version": "<doc-version>"
},
"group": {
"groupName": "<分组名称>",
"module": "<group-module>"
},
"methods": [
{
"method": "<module.method>",
"description": "<接口说明>",
"isNeedAuth": false,
"isNeedLogin": true,
"headers": [],
"params": [
{
"name": "<param-name>",
"type": "string",
"required": true,
"source": "body",
"description": "<参数说明>"
}
],
"response": [
{
"name": "<field-name>",
"type": "string",
"required": true,
"description": "<返回字段说明>"
}
],
"errors": [
{
"code": 400,
"message": "<错误说明>"
}
]
}
],
"change": {
"version": "<YYYY.MM.DD-docName-xx>",
"date": "<YYYY-MM-DD>",
"summary": "<本次变更摘要>",
"methods": [
"<module.method>"
],
"notes": [
"<变更说明 1>",
"<变更说明 2>"
],
"type": "updated"
}
}