Add under-anything knowledge dashboard
This commit is contained in:
51
wishfulfilled-wiki/07_技术文档/接口说明模板.md
Normal file
51
wishfulfilled-wiki/07_技术文档/接口说明模板.md
Normal file
@@ -0,0 +1,51 @@
|
||||
---
|
||||
type: api_template
|
||||
tags: [技术文档, 接口, 模板]
|
||||
aliases: [接口模板, API说明模板]
|
||||
source: manual
|
||||
status: active
|
||||
owner: 技术负责人
|
||||
updated: 2026-05
|
||||
---
|
||||
|
||||
# 接口说明模板
|
||||
|
||||
## 基本信息
|
||||
|
||||
| 项目 | 内容 |
|
||||
|---|---|
|
||||
| 接口名称 | |
|
||||
| 所属模块 | |
|
||||
| 关联需求 | |
|
||||
| 负责人 | |
|
||||
| 状态 | draft |
|
||||
|
||||
## 接口用途
|
||||
|
||||
|
||||
## 请求说明
|
||||
|
||||
| 字段 | 类型 | 必填 | 说明 | 示例 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | |
|
||||
|
||||
## 响应说明
|
||||
|
||||
| 字段 | 类型 | 说明 | 示例 |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
## 业务规则
|
||||
|
||||
|
||||
## 异常码
|
||||
|
||||
| 异常码 | 含义 | 处理方式 |
|
||||
|---|---|---|
|
||||
| | | |
|
||||
|
||||
## Agent 检索字段
|
||||
|
||||
- 关键词:
|
||||
- 同义词:
|
||||
- 典型问法:
|
||||
Reference in New Issue
Block a user