69 lines
1.5 KiB
Markdown
69 lines
1.5 KiB
Markdown
# 接口文档
|
||
|
||
## 1. 数据模块
|
||
|
||
接口名称：新增接口【已完成】
|
||
|
||
接口路径： /api/data
|
||
|
||
请求方法： POST
|
||
|
||
**请求参数**
|
||
|
||
| 参数名 | 类型 | 是否必须 | 描述 |
|
||
| ----------- | ------ | ---- | ---- |
|
||
| name | string | 是 |数据名称 |
|
||
| description | string | 否 | 数据描述 |
|
||
| tags | string | 否 | 数据标签列表（必须是标签列表中的id）|
|
||
请求示例
|
||
```json
|
||
{
|
||
"name": "数据名称",
|
||
"description": "数据描述",
|
||
"tags": ["标签id1", "标签id2"]
|
||
}
|
||
```
|
||
|
||
**响应结果**
|
||
| 字段名 | 类型 | 描述 |
|
||
| --------- | --------- | ---- |
|
||
| code | number | 响应状态|
|
||
| msg | string | 响应消息|
|
||
|
||
|
||
响应类型：JSON
|
||
|
||
```json
|
||
{
|
||
"code": 201,
|
||
"msg": "新增成功"
|
||
}
|
||
```
|
||
|
||
接口名称：查询接口【完成80%，过滤逻辑待补充】
|
||
|
||
接口名称：编辑接口【待完成】
|
||
|
||
接口名称：删除接口【已完成，请自行查看代码】
|
||
|
||
|
||
## 2. 标签模块
|
||
|
||
接口名称：新增接口【已完成，请自行查看代码】
|
||
|
||
接口名称：查询接口【已完成，请自行查看代码】
|
||
|
||
接口名称：编辑接口【已完成，请自行查看代码】
|
||
|
||
接口名称：删除接口【已完成，请自行查看代码】
|
||
|
||
接口名称：批量删除接口【待完成】
|
||
|
||
## 3. 语言切换模块
|
||
|
||
|
||
接口名称：查询接口【已完成，请自行查看代码】
|
||
|
||
接口名称：设置接口【已完成，请自行查看代码】
|
||
|