效果

目录

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. J2EE [web] 403.500.404页面配置

    如果想让系统在出错后,看到自定义的错误提示页面,而不是满屏错误原因以及代码. 1.web.xml中 <error-page> <error-code>403</error ...

  2. 在centos7下安装python3的步骤

    环境搭建 准备工具: centos7:http://mirror.bit.edu.cn/centos/7/isos/x86_64/CentOS-7-x86_64-DVD-1611.iso virtus ...

  3. qemu对虚拟机的内存管理(二)

    上篇文章主要分析了qemu中对虚拟机内存管理的关键数据结构及他们之间的联系,这篇文章则主要分析在地址空间发生变化时,如何将其更新至KVM中,保持用户空间与内核空间的同步. 这一系列操作与之前说的Add ...

  4. UIScrollView上面的UIButton点击始终在中间

    -(void)btnClick:(IdleTopChoseBtn *)btn{ btn.selected = YES; _choseBtn.selected = NO; _choseBtn = btn ...

  5. Ocelot:API网关概要

    一.概要 Ocelot是.Net Core下一个开源API网关:Ocelot主要目标是在.NET在微服务或面向服务架构中提供统一的入口服务, Ocelot拿到HttpRequest对象到管道后,先创建 ...

  6. 一:window环境,LaTex快速安装(简单易懂)

    一.    下载 清华开源软件镜像:点我下载 在线安装很容易失败,所以咱们选择ISO的~ 二.    安装 解压texlive2018.iso文件,并使用管理员权限打开install-tl-windo ...

  7. Hibernate查询操作

    操作前需要创建好Hibernate项目,创建项目,可参考:http://www.cnblogs.com/zhaojinyan/p/9336174.html 一下的例子是从其他贴子粘过来的(知识无国界! ...

  8. 《linux就该这么学》第四节课笔记,三章和四章开始!

    第三章 (根据课本和在线培训视频排版总结,借鉴请改动)         右键可打开终端练习             3.1:输入输出重定向 输入重定向:符号 "<" ,是一种 ...

  9. 网页头部meta标签

    <meta http-equiv="content-Type" content="text/html;charset=UTF-8">    //设置 ...

  10. spring boot + vue + element-ui全栈开发入门——前后端整合开发

    一.配置 思路是通过node的跨域配置来调用spring boot的rest api. 修改config\index.js文件,设置跨域配置proxyTable: proxyTable: { '/ap ...