xxx项目接口文档模板

简介:  XXX项目接口       版本 编写人员 备注                                              1   站点信息接口1.1      接口描述         查询填报单位信息及栏目信息1.2      接口参数提交路径:测试:ht

 

XXX项目接口

 

 

 

 

 

 

 

版本

编写人员

备注

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

1   站点信息接口

1.1      接口描述

         查询填报单位信息及栏目信息

1.2      接口参数

提交路径:

测试:http://ip:8080/urlxxx

正式内网:http://ip:9080/urlxxx

请求方式:POST/GET

参数说明:

参数名称

默认值

范围

备注说明

Key1

 

xxx

Key2

 

xxxx

1.3      返回样例

{

 "hasPrev": false,

 "pageTotal": 1,

 "hasNextPage": null,

 "pageSize": 25,

 "pageNo": 1,

 "recordSize": 1,

 "hasNext": false,

 "data": [

    {

     "key1": "1100000205",

     "key2": null,

      "list": [

       {

         "key1": "1100000205",

         "key2": null

        },

      ],

     "key3": 1479363148000,

     "key3": "林琳"

    }

  ]

}

 

1.4      返回字段说明

站点信息:

参数名称

参数说明

范围

Key1

首页url

Key2

Xxxx

栏目信息:

参数名称

参数说明

范围

Key3

描述

 

Key4

Xxx字段

 

 


目录
相关文章
|
7月前
|
Java 数据库连接 Spring
JavaWeb优雅实现接口参数校验
JavaWeb优雅实现接口参数校验
70 0
egg 项目里编写基础的 GET 接口:使用 GET 请求参数获取
egg 项目里编写基础的 GET 接口:使用 GET 请求参数获取
133 0
egg 项目里编写基础的 GET 接口:使用 GET 请求参数获取
|
30天前
|
Java API Maven
SpringBoot 调用外部接口的三种方式--学习总结
SpringBoot 调用外部接口的三种方式--学习总结
32 1
|
2月前
|
SQL
​注入工具 -- sqlmap(获取目标)
​注入工具 -- sqlmap(获取目标)
28 0
|
2月前
|
存储 测试技术 Python
带有参数依赖的接口该如何测试?
带有参数依赖的接口该如何测试?
|
3月前
|
JavaScript 前端开发 API
在vue中如何获取项目src外层的config目录以及api接口proxy的target代理地址
在vue中如何获取项目src外层的config目录以及api接口proxy的target代理地址
22 0
|
3月前
|
Java 数据库 Spring
Springboot项目中VO包的含义
Springboot项目中VO包的含义
47 0
给EF框架自动生成实体类修改名字
给EF框架自动生成实体类修改名字
|
5月前
|
Web App开发 缓存 前端开发
前端项目根据环境设置请求地址和接口代理,以及解决多个localhost服务token被覆盖
一般开发项目除了正式的生产环境,还会有对应的开发环境、测试环境和预发布环境,每个环境所访问的接口地址肯定不一样,如果自己一个个手动修改那就太不程序猿了
176 1
|
10月前
ts解决依赖引入报错:无法找到模块“xxxxxx”的声明文件的报错问题
ts解决依赖引入报错:无法找到模块“xxxxxx”的声明文件的报错问题
1432 0