记录一个Markdown编写的接口文档模版

接口名称

1) 请求地址

https://127.0.0.1/api?a=xx&b=xx

2) 调用方式：HTTP post

3) 接口描述：

接口描述详情

4) 请求参数:

GET参数:

字段名称	字段说明	类型	必填	备注
a		str	Y	-
b		str	Y	-

5) 请求返回结果:

{
"errNum": 10001,
"errMsg": "Param Error"
}

6) 请求返回结果参数说明:

字段名称	字段说明	类型	备注
a		str	-
b		str	-

## 接口名称### 1) 请求地址>https://apis.cnblogs.com/user/info?a=xx&b=xx### 2) 调用方式：HTTP post### 3) 接口描述：* 接口描述详情### 4) 请求参数:#### GET参数:
|  字段名称   | 字段说明 | 类型 | 必填 | 备注 |
|  ----  | ----  | ----  |----  |----  |
| a  |  | str | Y | - |
| b  |  | str | Y | - |### 5) 请求返回结果:#```去掉#号
{"errNum": 10001,
"errMsg": "Param Error"
}
#```### 6) 请求返回结果参数说明:
|  字段名称   | 字段说明 | 类型 | 备注 |
|  ----  | ----  | ---- |----  |
| a  |  | str | - |
| b  |  | str | - |

记录一个Markdown编写的接口文档模版相关推荐

接口文档如何编写，接口文档快速生成工具
正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要.下面我总结下自己看到的优秀接口文档. 一.背景介绍接口:API API(Applic ...
使用swagger编写开发接口文档
1.在pom.xml中导入依赖 <dependency><groupId>io.springfox</groupId><artifactId>sprin ...
[转] Mou 一个Markdown工具语法规则文档（最后）
原文地址:http://blog.csdn.net/coolwxb/article/details/50803602 View 显示预览窗口 Toggle live preview: Shift + ...
Markdown写接口文档，自动添加TOC
上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown ...
laravel api生成接口文档
安装 composer require foryoufeng/laravel-doc 如果报错: composer更新报错问题Carbon 1 is deprecated, see how to mi ...
Java—使用ApiDoc接口文档
Java-使用ApiDoc接口文档前言介绍: 之前写过使用Swagger编写Api接口文档 ,介绍了Java怎么使用Swagger做项目的Api接口文档.也百度过现在生成Api接口文档的工具,看到 ...
芋道 Spring Boot API 接口文档 Swagger 入门
点击上方"芋道源码",选择"设为星标" 做积极的人,而不是积极废人! 源码精品专栏原创 | Java 2020 超神之路,很肝~ 中文详细注释的开源项目 RP ...
轻松完成word格式的接口文档
今天在开发完一个项目的接口之后,公司领导过来说:"需要一份word格式的接口文档,***本门主任需要看这些文档,记得接口文档做的好看一点".然后领导拍拍我的肩膀转身就走了,身为一个 ...
Apipost让您轻松完成接口测试及接口文档，告别加班
1.日常琐事逃不掉作为一名后端开发工作者,多年来我的日常工作就是接口编码,接口测试,接口联调,接口文档编写.这四件事情就像四座大山直挺挺地压我的心头. 多年来我也一直在苦苦寻找着能提高接口测试联调效 ...
如何用Postman写接口文档，团队协作开发
最近为了减少对代码的侵入性,舍弃了之前一直使用的Swagger,但是showdoc写文档又比较麻烦,测试接口也不方便,于是看了一下网上的多篇关于postman写接口文档的文章,并且亲身实验后将经验结合 ...

记录一个Markdown编写的接口文档模版

接口名称

1) 请求地址

2) 调用方式：HTTP post

3) 接口描述：

4) 请求参数:

GET参数:

5) 请求返回结果:

6) 请求返回结果参数说明:

记录一个Markdown编写的接口文档模版相关推荐

最新文章

热门文章