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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343