接口文档模板（Markdown）

效果

目录

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)

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

时间： 2024-10-08 18:48:53

接口文档模板（Markdown）的相关文章

常用接口文档模板

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

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

Api接口文档管理工具，你知道哪些呢？

上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的这个年代,Api接口文档管理工具越来越显得重要.完整的Api接口文档能大大提升前后端开发协作的效率. image 目前市场有哪些比较优秀的接口文档管理工具呢?Swagger Api接口文档工具到底如何,我大致汇总一下吧! 一.Swagger 说到Swagger,他确实是为开发者发明的一款神器,他可以

附录1：接口文档参考模板

https://www.w3cschool.cn/phalapi/5fhi1tth.html 附录1:接口文档参考模板 由 chanzonghuang 创建,最后一次修改 2016-11-20 虽然提供了在线接口参数的查看,但在和客户端对接过程中,我们作为后台开发,还是需要人工提供接口文档给客户端的,这里提供一个接口文档编写的模板,以供参考,并且以我们熟悉的?service=User.GetBaseInfo为例说明如何编写高效的文档. 温馨提示:斜体字表示是注释说明. 功能说明 对接口功能的简单

[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描述

如何利用apidoc来写接口文档

在开发后台接口的过程中,肯定要提供一份api接口文档给终端.一直用word写,太丑了..怎么才能做出一份漂亮的api文档呢?找了好久发现了今天的主角-apidoc. 官网地址:http://apidocjs.com 开放API已经成为当下主流平台的一个要素,特别对于社交.电商类的平台开放API更成为了竞争力的一种.开放API文档的完整性.可阅读性往往影响着接入方是否能顺利地.快速地接入到平台,一份好的.统一的API文档也是开放平台不可或缺的要素. apidoc是通过源码中的注释来生成API文档,

接口文档要如何写

一个简单的接口文档,写完给组长看后,发现漏洞百出.下面总结一下写文档需要注意事项:        封皮 封面最好是本公司规定的封面,有logo,内容标题,版本号,公司名称,文档产生日期.(错误地方在于,文档的标题要和页眉中的标题一致)        修订历史 表格形式较好些.包括,版本,修订说明,修订日期,修订人,审核时间审核人.(我错误的地方在于,表格中其他空白表格没有居中)        接口信息 接口调用方式,是post方式还是get方式,接口地址,别人需要线上的哪个地址就写哪个.(自己提

开发接口文档--本接口文档是读取控制器方法上的注释自动生成的

本文档是参考网上的然后根据公司需要对代码进行了抽取和优化(主要是加了标题栏和对输出进行了格式化输出,更换呢了页面渲染方式(改为直接使用php进行渲染,原来的是使用了模板引擎),可读性较好),配置简单,读取方便,和项目耦合性较小,只需要将api_view这个文件夹放到和项目同级就可以使用,接口文档只有100多k大小 1.配置控制器 按照上图格式写接口方法注释(主是在控制器上面和方法上) 2.将接口文档放置在和项目同级 注:上面3个事项目,最下面的是接口文档 3.配置接口文档配置文件 api_vie

给WebApi添加SwaggerUI,生成可交互接口文档

在ABP模板项目中,通过SwaggerUI可以为我们的WebApi生成动态的可交互接口文档页面,从而很方便的测试调用我们的WebApi接口. 1.集成Swagger 右键项目YoYo.Web,打开NuGet程序包管理器,添加Swashbuckle. 其中包含了程序和UI,安装后在App_Start文件夹下生成SwaggerConfig.cs. 完成这一步,Swagger已经集成完毕. 可以访问http://localhost:XXXX/swagger/ui/index. 如果出现异常,可以先尝试