使用markdown编写简单的接口文档
2023-02-18 16:43:42 时间
如题,使用markdown格式写接口文档效率还是挺高的,因为你只需要关系接口的功能和内容,而不用在意排版,顺带提一下使用这个工具markdown_tables创建markdown格式的表格不要太方便!
需要说明的是如果是大型多人合作项目,还是老老实实用apidoc等工具吧。
接口大类
-----------
[toc]
-----------
### 接口1
#### 接口功能
> 接口说明
#### 接口地址
> 接口地址
#### 返回格式
> JSON
#### 请求方式
> GET
#### 请求参数
| 参数 | 必选 | 类型 | 默认值 | 说明 |
|------|------|--------|--------|-----------------------------------------|
| name | ture | string | foo | 请求的项目名 |
| type | true | int | bar | 请求项目的类型。1:类型一;2:类型二 。 |
#### 返回字段
| 返回字段 | 字段类型 | 说明 |
|----------|----------|----------------------------------|
| result | int | 返回结果状态。0:正常;1:错误。 |
| reason | string | 错误说明 |
| data | string | 数据 |
#### 字段变化
字段变化说明
#### 接口示例
> 地址:接口地址示例
#```json
{
"result": 0,
"reason": "success",
"data": []
}
#```
代码里的
#
请删除
相关文章
- 教育行业案例:如何分析复购用户?
- 销售数据发生波动,怎么办?
- 这3个原则可以提高你的工作效率
- 学会这个,1秒就可以批量处理文件
- Polardb 核心存储 polarfs 是怎么进行数据存储的(1)--译
- Polardb 核心存储 polarfs 是怎么进行数据存储的之核心构造(2)--译
- 2022 DBA 角色转换 挑战 与 机遇
- 监控系统的建设思路
- Html+CSS小案例项目:CSS开发小米商城电商产品展示效果
- Polardb 核心存储 polarfs 是怎么进行数据存储的之核心构造(3)--译
- BI和报表到底有什么区别?
- 浅谈有赞搜索QP架构设计
- Spark App 血缘解析方案
- 数据中心建设思路与方案
- 知识库检索匹配的服务化实践
- 数字孪生之十大问
- JVM和机器规格调优在有赞的实践
- 大数据平台数据管控整体解决方案
- 大数据治理平台应用解决方案
- pr2023最新永久版视频编辑软件Premiere2023下载安装