zoukankan      html  css  js  c++  java
  • 接口文档模板(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)
    
  • 相关阅读:
    MySQL Explain优化
    mysql联合索引
    MySQL索引类型
    php常用的排序算法与二分法查找
    mysql 主从复制(mysql双机热备的实现)
    mysql 主从复制 (2)
    Linux 查看进程之PS命令
    PHP isset 和 array_key_exists 对比
    Linux md5sum 的用法
    Linux Sphinx 安装与使用
  • 原文地址:https://www.cnblogs.com/bqwzx/p/10587706.html
Copyright © 2011-2022 走看看