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/qualityI

源码地址



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



目录
相关文章
|
XML 前端开发 JavaScript
Markdown 拓展-Docsify 构建接口文档
优点:使用 markdown 编写,docsify 作为支撑。快速高效,若搭载搜索功能,功能较为完善。且可部署在内网环境。 缺点:不支持直接点击按钮进行 HTTP 请求,需要手动粘贴参数到 POSTMAN 等工具。 Docsify 初始化 & 运行
136 0
Markdown 拓展-Docsify 构建接口文档
|
存储 设计模式
使用Markdown写博客的一些模板
傍晚时分,你坐在屋檐下,看着天慢慢地黑下去,心里寂寞而凄凉,感到自己的生命被剥夺了。当时我是个年轻人,但我害怕这样生活下去,衰老下去。在我看来,这是比死亡更可怕的事。--------王小波
502 0
|
算法 PHP 开发工具
php markdown 接口文档生成工具
2017年9月18日 19:20:22 星期一 效果:   码云: https://gitee.com/myDcool/PHP-Markdown.git 说明: 简单的MarkdownApi管理工具:左侧目录树: dtree.
1448 0
|
2月前
|
程序员 Linux iOS开发
一款比Typora更简洁优雅的Markdown编辑器神器(完全开源免费)
一款比Typora更简洁优雅的Markdown编辑器神器(完全开源免费)
121 1
|
2月前
《使用「Markdown」编辑器的那些天 |CSDN编辑器测评》
《使用「Markdown」编辑器的那些天 |CSDN编辑器测评》
38 0
|
2月前
|
机器学习/深度学习 uml
Markdown编辑器用法保存自用
Markdown编辑器用法保存自用
|
2月前
|
Linux Docker 容器
Linux本地搭建StackEdit Markdown编辑器结合内网穿透实现远程访问
Linux本地搭建StackEdit Markdown编辑器结合内网穿透实现远程访问
54 0
|
1月前
|
存储 移动开发 编解码
基于HTML5开发的Markdown在线编辑器
Markdown是一种轻量级标记语言,以其简洁易读的格式而备受程序员和作者们的青睐。随着互联网的发展,越来越多的在线Markdown编辑器应运而生,为用户提供了更加便捷、高效的写作和编辑环境。本文将探讨基于HTML5开发的Markdown在线编辑器的设计原理、功能特点以及技术优势。
72 4