Macdown接口文档模板

Bertha 。 2023-06-23 03:57 1阅读 0赞

样式：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FsaWNlX3FpeGlu_size_16_color_FFFFFF_t_70][]

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  |最后更新人  |

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FsaWNlX3FpeGlu_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191217141028324.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FsaWNlX3FpeGlu,size_16,color_FFFFFF,t_70