效果

目录

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)的更多相关文章

  1. markdown格式接口文档模板

    源文件 https://files.cnblogs.com/files/bincoding/%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3.zip 目录 测试接口 查询指定项 ...

  2. TP框架(接口文档模板框架)

    https://blog.csdn.net/s390124971/article/details/51995497

  3. 我的第一个python web开发框架(23)——代码版本控制管理与接口文档

    书接上一回,小白和老菜聊到代码的版本控制和接口文档 小白:为什么要做版本控制,我不弄版本控制不也完成了项目了吗?要做版本控制不是很麻烦,又要安装服务又要提交代码,代码又不是多人用开发,还要写文档... ...

  4. Api接口文档管理工具,你知道哪些呢?

    上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的 ...

  5. Markdown写接口文档,自动添加TOC

    上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown ...

  6. php markdown 接口文档生成工具 SummerDoc

    2017年9月18日 19:20:22 星期一 因工作需要, 用PHP写了一个管理接口文档的小工具, 下边介绍一下: 浏览器展示的效果: 项目地址:(码云) 例子(http://doc.hearu.t ...

  7. 在sublime3中docblockr插件配置apidoc接口文档注释模板

    写在前面: 将进行3个步骤配置 1.在sublime3中安装插件docblockr,可以参考http://www.cnblogs.com/jiangxiaobo/p/8327709.html 2.安装 ...

  8. apidoc接口文档的快速生成

    官方文档连接:http://apidocjs.com/#demo apidoc是一个轻量级的在线REST接口文档生成系统,支持多种主流语言,包括Java.C.C#.PHP和Javascript等.使用 ...

  9. JApiDocs(自动生成接口文档神器)

    JApiDocs教程 前言 作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档.写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我 ...

随机推荐

  1. Compile caffe on unbutu 16.0.4

    1. apt-get install libprotobuf-dev libleveldb-dev libsnappy-dev libopencv-dev libboost-all-dev libhd ...

  2. 添加一个Activity

    #Android中增加一个Activity 1. 在AndroidManifest.xml中增加: <activity android:name="com.example.NewAct ...

  3. python摸爬滚打之day26----网络编程之socket

    1.网络通信原理 互联网的本质就是一系列的网络协议, 统称为互联网协议. 互联网协议的功能:定义计算机如何接入internet,以及接入internet的计算机通信的标准. 互联网协议按照功能不同分为 ...

  4. python采集百度搜索结果带有特定URL的链接

    #coding utf-8 import requests from bs4 import BeautifulSoup as bs import re from Queue import Queue ...

  5. PHP 二位数组按照下标排序

    1.排序得内容 array(6) { [0] => array(12) { [0] => string(3) "160" [1] => string(2) &qu ...

  6. [js]jquery里的jsonp实现ajax异源请求

    同源请求-jquery <script type="text/javascript" src="http://apps.bdimg.com/libs/jquery/ ...

  7. 使用 Asp.net core 2.0 + Angular 4 构建车辆管理的Web应用程序

    https://www.codeproject.com/Articles/1210559/Asp-net-core-Angular-Build-from-scratch-a-web

  8. Python学习之数组类型一:

    Python学习之数组类型一: Numpy中的向量与矩阵: 1.创建:  向量.矩阵均由array函数创建,区别在于向量是v=array( [逗号分隔的元素] ), 矩阵是M=array( [[ ]] ...

  9. 第二章:python基础,数据类型

    """第二章:python基础,数据类型2.1 变量及身份运算补充2.2 二进制数2.3 字符编码每8位所占的空间位一个比特,这是计算机中最小的表示单位.每8个比特组成一 ...

  10. word之选中文本

    在word和notepad中: 特别是在文件很大,如果用鼠标下滑的话,不知道会滑多久呢, 快捷键+鼠标点击截至处