feat: expose API markdown doc
This commit is contained in:
@@ -25,6 +25,7 @@
|
||||
| 单绩效域详情 | `/api/performance-domains/{id}.json` |
|
||||
| 工件反查使用情况 | `/api/artifacts/{id}/usage.json` |
|
||||
| 工具反查使用情况 | `/api/tools/{id}/usage.json` |
|
||||
| Markdown 接口文档 | `/apidoc` |
|
||||
|
||||
## 3. 接口说明
|
||||
|
||||
@@ -397,6 +398,23 @@
|
||||
|---|---|
|
||||
| `usedIn` | 使用该工具与技术的过程数组 |
|
||||
|
||||
---
|
||||
|
||||
### 3.13 Markdown 接口文档
|
||||
|
||||
用于让外部系统直接读取本说明文档。
|
||||
|
||||
`GET /apidoc`
|
||||
|
||||
响应体为 Markdown 文本字符串,不作为附件下载。
|
||||
|
||||
示例响应:
|
||||
|
||||
```markdown
|
||||
# 知识库 API 接口说明
|
||||
...
|
||||
```
|
||||
|
||||
## 4. 常用调用示例
|
||||
|
||||
```text
|
||||
@@ -420,4 +438,7 @@
|
||||
|
||||
反查专家判断在哪些过程中使用:
|
||||
/api/tools/TT001/usage.json
|
||||
|
||||
读取接口 Markdown 文档:
|
||||
/apidoc
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user