码迷,mamicode.com
首页 > 其他好文 > 详细

接口文档模板(Markdown)

时间:2019-03-24 13:44:56      阅读:334      评论:0      收藏:0      [点我收藏+]

标签:www   company   json   any   属性   ring   header   ref   状态   

效果

目录

1. 查询指定项目属性接口


1. 查询指定项目属性

接口功能

获取制定项目的分类信息

URL

http://www.api.com/index.php

支持格式

JSON

HTTP请求方式

GET

请求参数
> 参数 必选 类型
name ture string 请求的项目名
type true int 请求项目的类型。1:类型一;2:类型二 。
返回字段
> 返回字段 字段类型
status int 返回结果状态。0:正常;1:错误。
company string 所属公司名
category string 所属类型
接口示例

地址:http://www.api.com/index.php?name="可口可乐"&type=1

{
    "statue": 0,
    "company": "可口可乐",
    "category": "饮料",
}

目录

1. 查询指定项目属性接口


1. 查询指定项目属性

接口功能

获取制定项目的分类信息

URL

http://www.api.com/index.php

支持格式

JSON

HTTP请求方式

GET

请求参数
> 参数 必选 类型
name ture string 请求的项目名
type true int 请求项目的类型。1:类型一;2:类型二 。
返回字段
> 返回字段 字段类型
status int 返回结果状态。0:正常;1:错误。
company string 所属公司名
category string 所属类型
接口示例

地址:http://www.api.com/index.php?name="可口可乐"&type=1

源码


目录

1\. 查询指定项目属性接口

---

**1\. 查询指定项目属性**
###### 接口功能
> 获取制定项目的分类信息

###### URL
> [http://www.api.com/index.php](www.api.com/index.php)

###### 支持格式
> JSON

###### HTTP请求方式
> GET

###### 请求参数
> |参数|必选|类型|说明|
|:-----  |:-------|:-----|-----                               |
|name    |ture    |string|请求的项目名                          |
|type    |true    |int   |请求项目的类型。1:类型一;2:类型二 。|

###### 返回字段
> |返回字段|字段类型|说明                              |
|:-----   |:------|:-----------------------------   |
|status   |int    |返回结果状态。0:正常;1:错误。   |
|company  |string | 所属公司名                      |
|category |string |所属类型                         |

###### 接口示例
> 地址:[http://www.api.com/index.php?name="可口可乐"&type=1](http://www.api.com/index.php?name="可口可乐"&type=1)

接口文档模板(Markdown)

标签:www   company   json   any   属性   ring   header   ref   状态   

原文地址:https://www.cnblogs.com/bqwzx/p/10587706.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!