Markdown编写接口文档模版


接口名称

1) 请求地址

https://apis.cnblogs.com/user/info?a=xx&b=xx

2) 调用方式:HTTP GET

3) 接口描述:

  • 接口描述详情

4) 请求参数:

GET参数:

字段名称 字段说明 类型 必填 备注
a string Y -
b string Y -

5) 请求返回结果:

{
    "errNum": 10001,
    "errMsg": "Param error"
}

6) 请求返回结果参数说明:

字段名称 字段说明 类型 必填 备注
errNum string Y -
errMsg string Y -

END



## 接口名称

### 1) 请求地址

>https://apis.cnblogs.com/user/info?a=xx&b=xx

### 2) 调用方式:HTTP post

### 3) 接口描述:

* 接口描述详情

### 4) 请求参数:

#### GET参数:
|字段名称 |字段说明 |类型 |必填 |备注 |
| -------------|:--------------:|:--------------:|:--------------:| ------:|
|a||string|Y|-|
|b||string|Y|-|

### 5) 请求返回结果:

```
{
"errNum": 10001,
"errMsg": "Param Error"
}
```

### 6) 请求返回结果参数说明:
|字段名称 |字段说明 |类型 |必填 |备注 |
| -------------|:--------------:|:--------------:|:--------------:| ------:|
|errNum||string|Y|-|
|errMsg||string|Y|-|

原文地址:https://www.cnblogs.com/dafengdeai/p/11875407.html

时间: 2024-11-08 08:11:43

Markdown编写接口文档模版的相关文章

[API]使用Blueprint来高雅的编写接口文档

Blueprint(http://apiary.io/)是apiary公司的工具包,用来编写API文档,类似于Markdown,是一种标记语言. 对于习惯使用RESTful API的同志们来说,使用Blueprint可以快速的写出高雅大气的文档: 下面以一个Github中的Gist服务为例,简单的演示一下Blueprint的应用. 原文地址:http://blog.callmewhy.com/2014/06/05/blueprint-tutorial/ API Blueprint是一套API描述

开发底层硬件应该怎么编写接口文档

开发底层硬件应该怎么编写接口文档 这几天在做超市RFID结算系统的上位机程序编写,用的是VB.NET.底层用的是别人开发好的SDK,为什么要写这一篇文章呢?最近因为手头设备的功能限制,我就在网上找其他的公司的RFID射频卡读写器,由于我是做上层开发,所以需要设备供应商提供底层SDK二次开发包,找了好多设备提供商 ,也跟他们索取各自提供的SDK,但总的来说,我还是觉得最先用的这个设备的厂家提供的SDK是最详细的,现在简单说明如下: 一.函数说明: 1.目录结构清晰: 2.函数返回值,参数用表格说明

使用 Laravel-Swagger 编写接口文档(php)

使用 Laravel-Swagger 编写接口文档 Table of Contents Swagger 文档管理 官方网站:https://swagger.io/ 快速编写你的 RESTFUL API 接口文档工具,通过注释定义接口和模型,可以和代码文件放置一起,也可以单独文件存放. 优势 通过代码注解定义文档,更容易保持代码文档的一致性 模型复用,减少文档冗余,带来更可靠的文档 提供客户端访问接口,可以直接调试接口,不需要第三方工具进行调用测试接口 支持权限认证,等功能 Laravel Swa

使用Spec Markdown 编写手册文档

Spec Markdown 是一个基于markdown 的文档编写工具,安装简单,可以让我们编写出专业的文档 参考项目 https://github.com/rongfengliang/spec-md-demo 安装 全局 npm install -g spec-md 本地项目依赖 npm install --save-dev spec-md 项目使用 因为个人原因,比较喜欢使用yarn,所以项目基于yarn 初始化 初始化 yarn init -y 配置构建&&依赖 yarn add s

markdown格式接口文档模板

目录 测试接口 查询指定项目属性** 接口功能 获取制定项目的分类信息 接口地址 https://www.bincoding.cn/test HTTP请求方式 POST JSON 请求参数 参数 必选 类型 说明 name ture string 请求内容1 type true int 请求内容2 返回字段 返回字段 字段类型 说明 code int 返回状态,0 成功, 9失败 msg string 成功/失败提示 data string 响应内容 接口示例 地址:https://www.bi

接口文档

什么是接口文档? 在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护. 为什么要使用接口文档? 1.项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发. 2.项目维护中或者项目人员更迭,方便后期人员查看.维护. 接口文档的核心是什么? 接口核心分为四个部分: 请求方法. uri.请求参数.返回参数. 请求方法: 即请求的方法是什么.常用的请求方法有get.post.delete.

第05章—Swagger2打造在线接口文档

spring boot 系列学习记录:http://www.cnblogs.com/jinxiaohang/p/8111057.html 码云源码地址:https://gitee.com/jinxiaohang/springboot 一.添加Swagger2依赖 <dependency><!--添加Swagger依赖 --> <groupId>io.springfox</groupId> <artifactId>springfox-swagger

程序员不得的不会的接口文档

一.传统方式 众所周知,我们Java程序员在写完数据接口之后,想要前端或者App工程师调用的,需要写出接口文档,方便描述每一个接口都是干什么的,需要什么,怎么请求,返回的结果又是什么?可是现在的你是否还在手写接口文档呢?在手写接口文档中,有没有遇到,文档刚写好,测试反馈接口有问题,又不得不改写接口,结果接口改完之后,发送文档对不上了,怎么办? 我在工作中,是如何编写接口文档的呢?接下来给大家聊一神器,惊喜在后面. 首先,我新建一个项目,基于Spring Boot,开发几个接口,发布运行. 编写代

常用接口文档模板

接口规范说起来大,其实也就那么几个部分,接口规范.接口管理工具.接口文档编写.开发文档编写.以下将详细介绍,下面进入正文: 接口规范文档 具体内容如下: 一:协议规范 二:域名规范 三:版本控制规范 四:API路径规范 五:API命名规范 六:请求参数规范 七:列表请求特殊规范 八:返回数据规范 九:接口文档规范 十:接口管理工具使用教程 参与编写 更新日期 版本 备注 AbyssKitty 2018/04/06 V1.1.0 无 V1.1.0更新日志: 1. 新增协议规范.域名规范.版本控制规