Markdown 模板-实用接口文档的

源码地址

https://gitee.com/kaiLee/markdown-template/blob/master/%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3%E6%A8%A1%E6%9D%BF.md

展示效果

简要描述:

参数名 必选 类型 说明 举例
acceptNo string 受理号 6120200302000148
  • 该接口不返回保单号 和 投保人姓名数据, 需要前端从上个页面携带

cURL 描述:

curl --location --request POST 'http://aaa.bbb.ccc/ddd/product/qualityInspection/recordDetail' \
--header 'Content-Type: application/json' \
--data-raw '{   
    "acceptNo": "111"}'

请求方式:

  • POST

返回参数:

参数名 类型 说明
resultCode number 码值,200:成功;500:失败
resultMsg string 提示话术
resultBody object 依情况而定

返回 resultBody 说明

参数名 类型 说明
acceptNo string 受理号
inspector string 质检员
inspectionDate string 质检日期
status string 状态
reason string 原因
histories array 历史轨迹
├── dateTime string 操作时间
├── description string 操作后状态

返回示例

{
    "resultCode": 200,
    "resultMsg": "OK",
    "resultBody": {
        "acceptNo": "111",
        "inspector": "秦灵",
        "inspectionDate": "2020-01-09 06:06:16",
        "status": "不通过",
        "reason": "杨柳丝丝弄轻柔,烟缕织成愁。海棠未雨,梨花先雪,一半春休。而今往事难重省,归梦绕秦楼。相思只在,丁香枝上,豆蔻梢头。",
        "histories": [
            {
                "dateTime": "2020-12-19 10:32:06",
                "description": "质检通过"
            },
            {
                "dateTime": "2020-12-18 10:01:12",
                "description": "被抽取待人工质检"
            },
            {
                "dateTime": "2020-12-17 10:24:16",
                "description": "被抽取待人工质检"
            },
            {
                "dateTime": "2020-12-16 10:25:21",
                "description": "被抽取待人工质检"
            }
        ]
    }
}

备注
xxx

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

友情链接更多精彩内容