Skip to content

简介

小猫考试接口文档,旨在为开发者提供详细的API接口信息,包括接口地址、请求方式、请求参数、响应参数等,以便开发者能够快速进行系统集成和二次开发。

默认值与限制

日期格式

yyyy-MM-dd HH:mm:ss。

分页参数

  • curPage(当前第几页):默认为1。
  • pageSize(每页几条):默认为20,且最大不超过100。

响应码(code)

  • 200:请求正常。
  • 500:服务器内部错误。
  • 401:无权限或登录超时。

请求与响应

请求头

Authorization:必填字段,值为登录接口返回的data.accessToken。

响应头

Authorization:若响应头包含Authorization,缓存该值并用于下次请求头,以支持令牌续租。

请求方法

不限制:建议首选post

请求编码

默认表单格式:{ Content-Type: application/x-www-form-urlencoded }

响应参数

响应参数类型描述
codeInteger响应码
msgString响应消息
dataObject任意类型,可选

命名规则

接口命名

遵循“主业务/子业务”的命名方式,如:user/add:表示用户添加接口。

传参命名

  • 不带前缀:表达主业务+字段的意思,如user/add?id=1,id表示用户ID=1
  • 带前缀:表达前缀业务+字段的意思,如user/add?orgId=1,orgId表示机构ID=1

小猫考试