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

常用接口文档模板(markdown版)目录 1 查询指定项目属性接口 1 查询指定项目属性接口功能获取制定项目的分类信息 URLhttp www api com index php 支持格式 JSONHTTP 请求方式 GET 请求参数参数必选类型说明 nameturestri

目录

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://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) javascript { "statue": 0, "company": "可口可乐", "category": "饮料", }
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/220921.html原文链接:https://javaforall.net

(0)
上一篇 2026年3月17日 下午7:20
下一篇 2026年3月17日 下午7:21


相关推荐

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号