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字段

 

 


目录
相关文章
egg 项目里编写基础的 GET 接口:使用 GET 请求参数获取
egg 项目里编写基础的 GET 接口:使用 GET 请求参数获取
188 0
egg 项目里编写基础的 GET 接口:使用 GET 请求参数获取
|
2月前
|
安全 Linux 网络安全
构建leanote云笔记报错:xxx.xxx.xxx.xxx拒绝我们的连接请求
构建leanote云笔记报错:xxx.xxx.xxx.xxx拒绝我们的连接请求
33 4
|
5月前
|
存储 前端开发 Java
SpringBoot使用云端资源url下载文件的接口写法
在Spring Boot中实现从云端资源URL下载文件的功能可通过定义REST接口完成。示例代码展示了一个`FileDownloadController`,它包含使用`@GetMapping`注解的方法`downloadFile`,此方法接收URL参数,利用`RestTemplate`下载文件,并将文件字节数组封装为`ByteArrayResource`返回给客户端。此外,通过设置HTTP响应头,确保文件以附件形式下载。这种方法适用于从AWS S3或Google Cloud Storage等云服务下载文件。
501 7
|
2月前
|
Java 编译器
“公共类 XXX 应该在文件中出现”错误怎么查找解决
要解决“公共类XXX应该在文件中出现”的错误,首先定位报错的类名及文件,确认类声明是否为公共(public)。若问题未解,需检查文件命名与类名是否一致,及文件路径是否正确。确保这些要素正确无误可解决此问题。
57 12
|
4月前
|
前端开发 API
【API管理 APIM】APIM中如何配置使用URL路径的方式传递参数(如由test.htm?name=xxx 变为test\xxx)
【API管理 APIM】APIM中如何配置使用URL路径的方式传递参数(如由test.htm?name=xxx 变为test\xxx)
|
5月前
|
XML Java 数据格式
支付系统----微信支付20---创建案例项目--集成Mybatis-plus的补充,target下只有接口的编译文件,xml文件了,添加日志的写法
支付系统----微信支付20---创建案例项目--集成Mybatis-plus的补充,target下只有接口的编译文件,xml文件了,添加日志的写法
怎样创建接口文档,接口请求要学会改名
怎样创建接口文档,接口请求要学会改名
|
6月前
|
Java Maven
java运行jar包提示 “XXX中没有主清单属性”,配置maven插件
java运行jar包提示 “XXX中没有主清单属性”,配置maven插件
|
6月前
|
Oracle Java 关系型数据库
各种数据库对应的jar包、驱动类名和URL格式
各种数据库对应的jar包、驱动类名和URL格式
82 0
|
7月前
|
Java API Maven
SpringBoot 调用外部接口的三种方式--学习总结
SpringBoot 调用外部接口的三种方式--学习总结
129 1