Files
peipei-backend/list_OpenAPI.json
2025-06-12 10:23:22 +08:00

246 lines
5.7 KiB
JSON

{
"swagger": "2.0",
"info": {
"description": "# 接口文档",
"version": "1.0",
"title": "接口文档",
"termsOfService": "http://www.xx.com/",
"contact": {
"name": "277769738@qq.com"
}
},
"host": "localhost:7002",
"basePath": "/api",
"schemes": [],
"consumes": [
"*/*"
],
"produces": [
"*/*"
],
"paths": {
"/api/clerk/user/list": {
"get": {
"tags": [
"play-clerk-user-info-controller"
],
"summary": "list",
"operationId": "listUsingGET_5",
"produces": [
"*/*"
],
"parameters": [
{
"name": "beginTime",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "clerkState",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "createdBy",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "createdTime",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "currentPage",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "deleted",
"in": "query",
"required": false,
"type": "boolean"
},
{
"name": "endTime",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "levelId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "listingState",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "nickname",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "onboardingState",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "pageNum",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "phone",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "province",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "recommendationState",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sex",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "typeId",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "updatedBy",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "updatedTime",
"in": "query",
"required": false,
"type": "string",
"format": "date-time"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"originalRef": "全局统一返回结果",
"$ref": "#/definitions/全局统一返回结果"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
}
},
"definitions": {
"全局统一返回结果": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"description": "返回码"
},
"data": {
"type": "object",
"description": "返回数据"
},
"message": {
"type": "string",
"description": "返回消息"
},
"pageInfo": {
"description": "分页信息",
"originalRef": "PageInfo",
"$ref": "#/definitions/PageInfo"
},
"success": {
"type": "boolean",
"description": "是否成功"
},
"total": {
"type": "integer",
"format": "int64",
"description": "总条数"
}
},
"title": "全局统一返回结果"
},
"PageInfo": {
"type": "object",
"properties": {
"currentPage": {
"type": "integer",
"format": "int32",
"description": "当前页",
"refType": null
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "页大小",
"refType": null
},
"totalCount": {
"type": "integer",
"format": "int64",
"description": "总记录数",
"refType": null
},
"totalPage": {
"type": "integer",
"format": "int64",
"description": "总页数",
"refType": null
}
},
"title": "PageInfo"
}
}
}