Macdown接口文档模板

样式：

macdown 代码：

#xxx接口文档
版本:版本 | 日期      |操作人
--- |---|---
v1  | 2019-10-11|xx
##1、根据筛选条件获取工单列表
###1.1接口url
前缀/xxxx/xxxx
###1.2请求方式
GET
###1.3请求头参数      |类型     |是否必传 |说明       | 示例     |
-------- |---------|--------|----------|---------|
token      | string  |是       |token    |V3       |
###1.4参数说明参数     |类型     |是否必传 |说明       | 示例     |
--------|---------|--------|----------|---------|
applyCode   | string  |否      |xxx    |2019100920240440258574|
emplid    | string  |否      |xxx    |D27704 |
emplName    | string  |否      |xxx     |布 |
ldap    | string  |否      |xxx     |aliceqixin|
deptId    | string  |否      |xxx     |105781|
deptName    | string  |否      |xxx     | 萨 |
typeId    | integer  |否      |xxx     | 7 |
applyStatus    | integer  |否      |xxx    |0 |
approvalStatus    | integer  |否      |xxx     |0 |
fileStatus    | integer  |否      |xxx     |0 |
state    | integer  |否      |xxx     |0 | ###1.5返回结果
```
{"data": [{"id": 9,"applyCode": "2019100920240440258574","emplid": "D27704","emplName": "xxx ","deptId": "105781","typeId": 7,"typeDesc": "其他用途","description": "其他用途","applyStatus": 1,"rejectReason": null,"auditTime": null,"updater": "aliceqixin","approvalStatus": 1,"rejectDesc": null,"fileStatus": 1,"fileTime": "2019-10-10 16:13:31","creator": "aliceqixin","gmtCreate": "2019-10-09 20:24:04","gmtUpdate": "2019-10-11 14:58:01","state": 0,"emplWordCardPhotoDtoList": null,"hrbpName": null,"hrbpLdap": null,"hrbpLdaps": null,"hrbpEmail": null,"hrbpEmails": null,"managerId": null,"managerEmail": null},],"currentPage": 1,"pageSize": 100,"totalPage": 1,"totalCount": 1
}
```
返回结果参数中字段说明：参数     |类型     |说明       |
--------|---------|----------|
id   | integer  |id       |
applyCode | string  |xxx   |
emplid    | string  |xxx |
emplName    | string |xxx   |
typeId    | integer  |申请类型id    |
typeDesc| string  |申请类型描述    |
description| string   |用途描述  |
applyStatus    | integer  |申请状态 0申请中  1申请通过待审核 2申请驳回   |
rejectReason| string  |申请驳回原因    |
approvalStatus    | integer   |流程审核状态,0审核中 1审核成功 2审核驳回  |
rejectDesc| string  |流程审核驳回描述    |
fileStatus    | integer    |文件状态    0未生成，1已生成 2失败|
state    | integer    |工单状态   工单状态 0进行中 1完成 2失败 |
gmtCreate| string  |创建时间   |
updater| string  |最后更新人  |

Macdown接口文档模板相关推荐

一份很不错的敏捷产品接口文档模板
在采用敏捷研发的过程中,前后端开发人员如何来描述与记录接口信息?如何精简的描述接口的用处?接口的请求方式?接口的入参是什么?返回模型是什么等等. 结合我们项目团队多年的实际情况以及授课老师的推荐,我觉 ...
https接口_API设计指南一个接口文档模板的最佳实践
1. 基础说明 1.1 背景 API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件的以访问一 ...
json接口文档模板_在.Net Core WebAPI下给Swagger增加导出离线文档功能
一丶前言最近刚接触到Swagger,在github上下载了它的源码和demo学习了一遍,发现这个组件非常好用,不过不足的是它没有导出离线文档的功能,于是乎我就想给它加一个导出功能 Swagger G ...
TP框架(接口文档模板框架)
https://blog.csdn.net/s390124971/article/details/51995497 转载于:https://www.cnblogs.com/wangyue0925/p/ ...
python web 文件管理_我的第一个python web开发框架（23）——代码版本控制管理与接口文档...
书接上一回,小白和老菜聊到代码的版本控制和接口文档小白:为什么要做版本控制,我不弄版本控制不也完成了项目了吗?要做版本控制不是很麻烦,又要安装服务又要提交代码,代码又不是多人用开发,还要写文档... ...
我的第一个python web开发框架（23）——代码版本控制管理与接口文档
书接上一回,小白和老菜聊到代码的版本控制和接口文档小白:为什么要做版本控制,我不弄版本控制不也完成了项目了吗?要做版本控制不是很麻烦,又要安装服务又要提交代码,代码又不是多人用开发,还要写文档... ...
SpringBoot 配置 generator代码生成+knife4j接口文档（2种模板设置、逻辑删除、字段填充含代码粘贴可用）保姆级教程（注意事项+建表SQL+代码生成类封装+测试类）
保姆级教程,逻辑删除及字段自动填充设置,特别要说明的是本次用的是MySQL数据库,如果使用Oracle数据库是,数据库配置需要改变,数据库表一定要大写,否则无法生成代码. 数据库表 CREATE TA ...
接口文档 HTML,附录1：接口文档参考模板
虽然提供了在线接口参数的查看,但在和客户端对接过程中,我们作为后台开发,还是需要人工提供接口文档给客户端的,这里提供一个接口文档编写的模板,以供参考,并且以我们熟悉的?service=User.Get ...
基于文档注释接口文档生成工具(代码0侵入附源码)
本文主要分享一个基于个人兴趣,旨在提高工作效率,开发了一个基于文档注释,接口文档生成工具,欢迎大佬指点. 源码以及使用demo地址 :传送门 1.前置介绍 1.1前世现在大多数项目都走向了前后端分离 ...

Macdown接口文档模板

Macdown接口文档模板相关推荐

最新文章

热门文章