markdown来写API接口文档

如下显示效果

XX项目API接口文档

通用说明:

①接口通用前缀:

测试环境: http://192.168.0.168:8081/wellLid

生产环境: 待定

② 接口通用返回:

{
    "code": "0000", // 正确码为0000 错误码为0001 
    "content": "", // 如发生错误此处会显示相关错误信息
    "result": { // 所有需要的结果集都会放在该对象中
        "id": 194,
        "token": "abb37e1dd94f47289f444b365e932707"
    }
}

---

1 登录模块

1.1 各移动端登录通用接口

• 说明

提供测试的账号
appType=2&userName=demo&passWord=123456

• 请求URL

/app/common/userLogin/getcheckUser.do

• 请求方式

POST

• 请求参数

请求参数	必选	参数类型	说明
appType	true	Integer	APP端类型 1管理端 2维修端 3安装端 4巡检端
userName	true	String	用户名
passWord	true	String	密码

• 返回字段

返回字段	字段类型	说明
logKey	Integer	随机生成的UUID可作为透传消息的唯一标识
userCode	String	用户ID

• 返回示例

// 正确示例
{
    "content": "",
    "code": "0000",
    "result": {
        "logKey": "52893f69-54d7-4bfb-b64f-a68aa3b49de4",
        "userCode": "babc7737-e34d-45fc-b75f-dff35b8126e5"
    },
    "url": null
}
// 错误示例
{
	"content": "类型不存在!",
	"code": "0001",
	"result": null,
	"url": ""
}

---

模板源码如下

不知道咋能在markdown里面不编译部分markdown语法,所以上传一下加个下载链接了，下载地址如下:
（资源分太贵可以加我QQ我发你931197485）
下载地址:https://download.csdn.net/download/zbx931197485/11037962