markdown格式接口文档模板

Posted bincoding

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了markdown格式接口文档模板相关的知识,希望对你有一定的参考价值。

目录


测试接口

查询指定项目属性**

接口功能

获取制定项目的分类信息

接口地址

https://www.bincoding.cn/test

HTTP请求方式

POST JSON

请求参数
参数 必选 类型 说明
name ture string 请求内容1
type true int 请求内容2
返回字段
返回字段 字段类型 说明
code int 返回状态,0 成功, 9失败
msg string 成功/失败提示
data string 响应内容
接口示例

地址:https://www.bincoding.cn/test
入参:

{
    "":"",
    "",""
}

响应:

{
    "code": 0,
    "msg": "请求成功",
    "data": ""
}

以上是关于markdown格式接口文档模板的主要内容,如果未能解决你的问题,请参考以下文章

快速编写接口api规范文档工具(Markdown)

Python脚本:快速将 Spring 在线官方文档格式化为 Markdown 格式文档

Apifox怎么导出jmeter文档

VS Code配置markdown代码片段

VS Code配置markdown代码片段

Markdown神器,程序员的利器哈哈