Api接口文档，API接口文档示例
接口文档
1.1接口文档说明
接口基准地址：
http://teaapi.wtycms.cn/
1
服务端已开启 CORS 跨域支持
API 认证统一使用 Token 认证
需要授权的 API ，必须在请求头中传递token字段提供 token 令牌
1.2登录验证接口
请求路径：login
请求参数
参数名 参数说明
name 用户名（测试账号：hnkj 密码123456）
password 密码
1.3注册接口
请求路径：Register
请求参数
参数名 参数说明 备注
rybh 用户名
pwd 密码
confirmPwd 确认密码 和pwd进行比对，两次密码输入一致才能注册，后台无需接收该参数
phone 手机号
qymc 企业名称
fzr 企业负责人
qylx 企业类型 默认值“茶叶"，状态为不可输入
xzq 行政区编号 默认值为 341524000000，前台无需显示
address 企业详细地址
1.3.1 注册信息校准
请求路径：isName
传递参数：name:rybh
请求路径：isPhone
传递参数：phone:phone
请求路径：isQymc
传递参数：qymc:qymc
备注：失焦时触发请求，提示用户信息是否被注册。
1.4 个人信息管理
请求路径：userInfo
请求参数
参数名 参数说明
token
1.4.1编辑个人信息
请求路径：DoEditUserInfo
请求参数
参数名 参数说明
token
rybh 登录名称
rymc 人员名称
groupname 所属组名
dh 联系方式
sex 性别
birth 出生日期
1.5企业信息管理
请求路径：BusinessInfo
请求参数
参数名 参数说明
token
1.5.1编辑企业信息
请求路径：DoEditBusinessInfo
请求参数
参数名 参数说明
token
qymc 企业名称
fzr 企业负责人
fzrtel 负责人手机号
addr 企业地址
qylx 企业类型
zyyw 主营业务
zycp 主营产品
jygm 经营规模
dwjj 企业简介
1.6土地信息
请求路径：PlaceInfo
请求参数
参数名 参数说明 备注
token token
page 当前页码，用于翻页 可以为空
query 关键字查询 可以为空
1.6.1新增土地信息
请求路径：AddPlaceInfo
请求参数：
参数名 参数说明 备注
token token
detailAddress 地块详细地址
lng 经度 通过百度地图api，输入地址转换为经纬度
lat 纬度
chandi 地块名称
yt 地块用途
1.6.2编辑土地信息
请求路径：EditPlaceInfo
用途：点击编辑按钮，弹出该条土地原本的信息
请求参数
参数名 参数说明 备注
token
bh 产地编号 首次请求土地数据，后端会穿bh到前台
请求路径：DoEditPlaceInfo
用途：提交已编辑的土地信息，完成信息修改。
请求参数：跟1.6.1新增土地信息保持一致
参数名 参数说明 备注
token token
detailAddress 地块详细地址
lng 经度 通过百度地图api，输入地址转换为经纬度
lat 纬度
chandi 地块名称
yt 地块用途
1.7产品信息
用途：首屏数据请求
请求路径：productInfo
请求参数：
参数名 参数说明 备注
token token
page 当前页码，用于翻页 可以为空
query 关键字查询 可以为空
1.7.1 新增产品信息
请求路径：AddProductInfo
请求参数：
参数名 参数说明 备注
token
cpmc 产品名称
picname 图片名称
cpgg 产品规格
bzq 保质期
ms 产品介绍
图片上传路径
uploadURL = 'http://teaapi.wtycms.cn/Productupload?token=' + token
1
上传成功后获取图片名称赋值给 picname，随表单一起提交给后台。
1.7.1 编辑产品信息
请求路径：EditProductInfo
用途：编辑产品时弹窗数据渲染
请求参数：
参数名 参数说明 备注
token token
bh 需要修改的产品编号 首屏数据请求中获取bh
请求路径：DoEditProductInfo
用途：修改完成后提交修改信息
请求参数：
参数名 参数说明 备注
token
cpmc 产品名称
picname 图片名称
cpgg 产品规格
bzq 保质期
ms 产品介绍
本文主要是提供了一个接口文档的范文，内容修订历史、目录、时序图、接口要素描述、接口说明、使用示例、字典、FAQ。
使用MD格式文档（makedown），选择原因，容易格式转换，开发便于修改，版本维护界面，修改记录明显，普通文本工具即可编辑。
下方是接口文档的示例：
**API说明**
## 修订历史
| 日期 | 内容 | 版本 | 作者 |
| ---------- | ------------------------------------------------------------ | -------- | ------ |
| 2021/09/10 | 初稿 | Ver. 1.0 | NHK|
## 目录
[TOC]
## 文档介绍
本文档用于XXX业务的接口说明和使用说明。
### 功能时序图
```sequence
API-> APISERVER: 系统连接
APISERVER -> API: 连接成功
API -> APISERVER: 系统登录
APISERVER --> API: 登录成功
API -> APISERVER: 业务请求
APISERVER --> API: 业务响应
API -> APISERVER: ......
APISERVER --> API: ......
API --> APISERVER: 系统连接断开
APISERVER -> API: 系统连接断开响应
```
## 接口要素描述
### 术语定义
- **JAVAGW：**系统的网关，有路由、广播等功能。
- **JAVAAPI：**JAVA语言所调用的程序，提供JAVA语言的API接口。直接连接JAVAGW。
- **APISERVER：**对外提供JSON格式接口，连接JAVAGW。
- **C++API ：**为C++语言提供的程序，连接APISERVER。
- **PythonAPI：**为PythonAPI语言提供的程序，连接APISERVER。
- **C#API ：**为C#语言提供的程序，连接APISERVER。
### 语法描述
#### 基础语法
接口使用JSON格式传输，语法规则遵循JSON语法规则。
#### **描述语法**
- **【0..0】：**表示无需赋值。
- **【0..1】：**表示可以有0个或1个实例。
- **【1..1】：**表示只能有一个实例。
- **【1..*】：**表示至少有一个实例。
- **【0..*】：**表示对实例的数目没有限制。
- **【X.Y】：**表示X集合内的Y属性。示例：参数【orderList.exchId】，orderlist中exhcId的参数，订单集合中市场属性。
- **【X^】：**表示X的集合中，有一个参数必送。示例：参数A ，参数标识【X^】 参数B ，参数标识【X^】 ，参数A、B必送一个。
### 数据类型
int：整数类型
long：长整型
double:浮点类型
String：字符串
list:代表数组或集合
## 接口清单
### 功能列表
| 接口 | 名称 | 接口支持 |
| ----- | ------------------ | -------- |
| 100000 | 功能1 |[✔]JAVA[✔]python|
#### 100000 -功能1
##### 接口定义
##### 注意事项
##### 参数说明
请求参数
| **参数** | 中文名称 | **类型** | 长度 | 参数标识 | 示例值 |
| ---------------------------------------------- | ---------------------------------------------- | -------- | ----- | -------- | ------ |
| **value** | 值1 | String | 1 | 【1..1】 | |
| **ValueList** | 值对象列表 | list | 999 | 【0..*】 | |
| **【ValueList.value1】** | 值对象1 | String | 35 | 【0..*】 | |
| **ValueList1** | 值列表1 | list | 999 | 【0..*】 | |
响应参数
| **参数** | 中文名称 | **类型** | 长度 | 参数标识 | 示例值 |
| ------------------------------------------ | ------------ | -------- | ---- | -------- | ------ |
| [**successFlg**](#successFlg-成功失败标识) | 成功失败标志 | int | 1 | 【1..1】 | 0 |
| **errorCode** | 错误代码 | String | 8 | 【0..1】 | |
| **failInfo** | 错误信息 | String | 200 | 【0..1】 | |
| **value** | 存取值1号 | string | 24 | 【1..*】 | |
##### DEMO范例
###### JAVAAPI
com.xxx..api.Interface.func(Funcvalue value)
```java
.....
```
## 使用示例（业务场景）
### XXX业务使用用例说明
#### 变更说明
#### XXX示例
## 数据字典
### successFlg-成功失败标识
|字典代码|名称|描述|
|------|--------------|--------|
|0|成功||
|1|失败||
## FAQ
版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。
发表评论
暂时没有评论，来抢沙发吧~