栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Python

个人习惯使用的接口文档格式

Python 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

个人习惯使用的接口文档格式

接口标题

1.接口描述
这是一个接口
2.接口基本信息:

请求url/contract/query
请求方式post
请求格式application/json
响应格式application/json

3.请求参数描述及示例:

1)请求参数描述:

参数名称类型必传说明
String是/否
  1. 请求示例:
{
}

4.返回值描述及示例:

  1. 返回参数描述:
参数类型说明
totalLong用户信息总条数
currentLong当前页码
sizeLong每页用户信息条数
recordsList<>

实体类

字段名称类型说明
  1. 返回示例:
{
	"success": true,
	"errorCode": 0,
	"errorMsg": "",
	"data": {
        total:10,
        current:1,
        size:10,
        records:[
        {
            
        },
        {
            
        }]
    }
}
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/317493.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号