xxx项目接口文档模板

    xiaoxiao2023-09-19  151

     

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

     

     

    相关资源:xxx项目接口检验测试报告模板
    最新回复(0)