美文网首页
常用接口文档模板(Markdown版)

常用接口文档模板(Markdown版)

作者: vincent_wei28 | 来源:发表于2018-05-31 23:50 被阅读0次

目录

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": "饮料",
}

相关文章

  • 常用接口文档模板(Markdown版)

    目录 1. 查询指定项目属性接口 1. 查询指定项目属性 接口功能 获取制定项目的分类信息 URL http://...

  • markdown 模板4 - 接口文档

    运营系统接口文档## [TOC] 接口说明 1、新增机器人 请求URL api/v2/operating/newR...

  • Markdown基本语法

    一、Markdown 官方文档 Markdown中文版语法说明 二、常用的语法规则 标题 总共六级标题,建议在#后...

  • 2019-01-10markdown(.md)的书写语法

    git中常用md来书写接口文档。为此。。。 phpstorm编辑器下markdown的插件 setting->Pl...

  • MarkDown语法

    一、Markdown 官方文档 Markdown 中文版语法说明

  • Markdown接口文档

    后端接口功能开发完成后,接入接口的同事需要知道每个接口的功能,以及请求需要带哪些参数等,所以,提供接口文档给别人查...

  • markdown语法指南

    Markdown 语法 Markdown 常用与书写博客,开发文档等‘.md’ 和 ‘.markdown’ 都是被...

  • 接口文档模板

    1.1彩种定义 1.2 推送接口 接口功能 测试URL [{host}/api/v2/schedules/cont...

  • 接口文档模板

    删除题目 接口说明 删除题目 请求参数 示例数据 返回参数 示例数据

  • Markdown 接口文档示例

    开发过程中经常需要整理接口并且写一份接口文档,这是使用MarkDown写的一份示例,先预览下样子: 接口列表 错误...

网友评论

      本文标题:常用接口文档模板(Markdown版)

      本文链接:https://www.haomeiwen.com/subject/gjacsftx.html