Files
tyapi-server/docs/swagger/docs.go
2025-07-15 13:21:34 +08:00

3989 lines
133 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// Package swagger Code generated by swaggo/swag. DO NOT EDIT
package swagger
import "github.com/swaggo/swag"
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {
"name": "API Support",
"url": "https://github.com/your-org/tyapi-server-gin",
"email": "support@example.com"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/api/v1/admin": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "分页获取管理员列表,支持搜索和筛选",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"管理员管理"
],
"summary": "获取管理员列表",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "每页数量",
"name": "size",
"in": "query"
},
{
"type": "string",
"description": "搜索关键词",
"name": "keyword",
"in": "query"
},
{
"type": "string",
"description": "状态筛选",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取管理员列表成功",
"schema": {
"$ref": "#/definitions/responses.AdminListResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"post": {
"security": [
{
"Bearer": []
}
],
"description": "创建新的管理员账户,需要超级管理员权限",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"管理员管理"
],
"summary": "创建管理员",
"parameters": [
{
"description": "创建管理员请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.CreateAdminCommand"
}
}
],
"responses": {
"201": {
"description": "管理员创建成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"403": {
"description": "权限不足",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/admin/auth/login": {
"post": {
"description": "使用用户名和密码进行管理员登录返回JWT令牌",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"管理员管理"
],
"summary": "管理员登录",
"parameters": [
{
"description": "管理员登录请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.AdminLoginCommand"
}
}
],
"responses": {
"200": {
"description": "登录成功",
"schema": {
"$ref": "#/definitions/responses.AdminLoginResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "用户名或密码错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/admin/change-password": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "修改当前登录管理员的密码",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"管理员管理"
],
"summary": "修改管理员密码",
"parameters": [
{
"description": "修改密码请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.ChangeAdminPasswordCommand"
}
}
],
"responses": {
"200": {
"description": "密码修改成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/admin/stats": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取管理员相关的统计数据",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"管理员管理"
],
"summary": "获取管理员统计信息",
"responses": {
"200": {
"description": "获取统计信息成功",
"schema": {
"$ref": "#/definitions/responses.AdminStatsResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/admin/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "根据管理员ID获取详细信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"管理员管理"
],
"summary": "获取管理员详情",
"parameters": [
{
"type": "string",
"description": "管理员ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "获取管理员详情成功",
"schema": {
"$ref": "#/definitions/responses.AdminInfoResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "管理员不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"put": {
"security": [
{
"Bearer": []
}
],
"description": "更新指定管理员的基本信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"管理员管理"
],
"summary": "更新管理员信息",
"parameters": [
{
"type": "string",
"description": "管理员ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "更新管理员请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.UpdateAdminCommand"
}
}
],
"responses": {
"200": {
"description": "管理员更新成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"403": {
"description": "权限不足",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "管理员不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "删除指定的管理员账户",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"管理员管理"
],
"summary": "删除管理员",
"parameters": [
{
"type": "string",
"description": "管理员ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "管理员删除成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"403": {
"description": "权限不足",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "管理员不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/categories": {
"get": {
"description": "获取产品分类列表,支持层级筛选",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"数据大厅"
],
"summary": "获取分类列表",
"parameters": [
{
"type": "string",
"description": "父级分类ID",
"name": "parent_id",
"in": "query"
},
{
"type": "integer",
"description": "分类层级",
"name": "level",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取分类列表成功",
"schema": {
"$ref": "#/definitions/responses.CategoryListResponse"
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/categories/{id}": {
"get": {
"description": "根据分类ID获取分类详细信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"数据大厅"
],
"summary": "获取分类详情",
"parameters": [
{
"type": "string",
"description": "分类ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "获取分类详情成功",
"schema": {
"$ref": "#/definitions/responses.CategoryInfoResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "分类不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "为用户创建新的企业认证申请",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "创建认证申请",
"responses": {
"200": {
"description": "认证申请创建成功",
"schema": {
"$ref": "#/definitions/responses.CertificationResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/contract": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "申请企业认证合同",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "申请合同",
"responses": {
"200": {
"description": "合同申请成功",
"schema": {
"$ref": "#/definitions/responses.CertificationResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/details": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取当前用户的认证申请详细信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "获取认证详情",
"responses": {
"200": {
"description": "获取认证详情成功",
"schema": {
"$ref": "#/definitions/responses.CertificationResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "认证申请不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/enterprise-info": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "提交企业基本信息,包括企业名称、统一社会信用代码、法定代表人信息等",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "提交企业信息",
"parameters": [
{
"description": "企业信息",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.SubmitEnterpriseInfoCommand"
}
}
],
"responses": {
"200": {
"description": "企业信息提交成功",
"schema": {
"$ref": "#/definitions/responses.CertificationResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/face-verify": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "发起企业法人人脸验证流程",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "发起人脸验证",
"parameters": [
{
"description": "人脸验证请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.InitiateFaceVerifyCommand"
}
}
],
"responses": {
"200": {
"description": "人脸验证发起成功",
"schema": {
"$ref": "#/definitions/responses.FaceVerifyResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/license/{record_id}/ocr-result": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "根据上传记录ID获取OCR识别结果",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "获取营业执照OCR识别结果",
"parameters": [
{
"type": "string",
"description": "上传记录ID",
"name": "record_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "获取OCR结果成功",
"schema": {
"$ref": "#/definitions/responses.UploadLicenseResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "记录不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/progress": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取当前用户的认证申请详细进度信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "获取认证进度",
"responses": {
"200": {
"description": "获取认证进度成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "认证申请不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/retry/{step}": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "重新执行指定的认证步骤",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "重试认证步骤",
"parameters": [
{
"type": "string",
"description": "步骤名称",
"name": "step",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "步骤重试成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/stats": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取认证申请的进度统计数据",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "获取进度统计",
"responses": {
"200": {
"description": "获取进度统计成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/status": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取当前用户的认证申请状态",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "获取认证状态",
"responses": {
"200": {
"description": "获取认证状态成功",
"schema": {
"$ref": "#/definitions/responses.CertificationResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/upload-license": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "上传营业执照文件立即进行OCR识别并返回结果",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "上传营业执照并同步OCR识别",
"parameters": [
{
"type": "file",
"description": "营业执照文件",
"name": "file",
"in": "formData",
"required": true
}
],
"responses": {
"200": {
"description": "上传成功",
"schema": {
"$ref": "#/definitions/responses.UploadLicenseResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未授权",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/finance/secrets": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取当前用户的API访问密钥信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户密钥管理"
],
"summary": "获取用户密钥",
"responses": {
"200": {
"description": "获取用户密钥成功",
"schema": {
"$ref": "#/definitions/responses.UserSecretsResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "密钥不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"post": {
"security": [
{
"Bearer": []
}
],
"description": "为用户创建API访问密钥",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户密钥管理"
],
"summary": "创建用户密钥",
"parameters": [
{
"description": "创建密钥请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.CreateUserSecretsCommand"
}
}
],
"responses": {
"201": {
"description": "用户密钥创建成功",
"schema": {
"$ref": "#/definitions/responses.UserSecretsResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"409": {
"description": "密钥已存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/finance/secrets/deactivate": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "停用用户的API访问密钥",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户密钥管理"
],
"summary": "停用用户密钥",
"responses": {
"200": {
"description": "用户密钥停用成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "密钥不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/finance/secrets/regenerate": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "重新生成用户的API访问密钥",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户密钥管理"
],
"summary": "重新生成访问密钥",
"responses": {
"200": {
"description": "访问密钥重新生成成功",
"schema": {
"$ref": "#/definitions/responses.UserSecretsResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "密钥不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/finance/wallet": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取当前用户的钱包详细信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"钱包管理"
],
"summary": "获取钱包信息",
"responses": {
"200": {
"description": "获取钱包信息成功",
"schema": {
"$ref": "#/definitions/responses.WalletResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "钱包不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"put": {
"security": [
{
"Bearer": []
}
],
"description": "更新当前用户的钱包基本信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"钱包管理"
],
"summary": "更新钱包信息",
"parameters": [
{
"description": "更新钱包请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.UpdateWalletCommand"
}
}
],
"responses": {
"200": {
"description": "钱包更新成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"post": {
"description": "为用户创建新的钱包账户",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"钱包管理"
],
"summary": "创建钱包",
"parameters": [
{
"description": "创建钱包请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.CreateWalletCommand"
}
}
],
"responses": {
"201": {
"description": "钱包创建成功",
"schema": {
"$ref": "#/definitions/responses.WalletResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"409": {
"description": "钱包已存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/finance/wallet/recharge": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "为钱包进行充值操作",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"钱包管理"
],
"summary": "钱包充值",
"parameters": [
{
"description": "充值请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.RechargeWalletCommand"
}
}
],
"responses": {
"200": {
"description": "充值成功",
"schema": {
"$ref": "#/definitions/responses.TransactionResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/finance/wallet/stats": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取钱包相关的统计数据",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"钱包管理"
],
"summary": "获取钱包统计",
"responses": {
"200": {
"description": "获取钱包统计成功",
"schema": {
"$ref": "#/definitions/responses.WalletStatsResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/finance/wallet/transaction": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "执行钱包内部交易操作",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"钱包管理"
],
"summary": "钱包交易",
"parameters": [
{
"description": "交易请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.WalletTransactionCommand"
}
}
],
"responses": {
"200": {
"description": "交易成功",
"schema": {
"$ref": "#/definitions/responses.TransactionResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/finance/wallet/withdraw": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "从钱包进行提现操作",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"钱包管理"
],
"summary": "钱包提现",
"parameters": [
{
"description": "提现请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.WithdrawWalletCommand"
}
}
],
"responses": {
"200": {
"description": "提现申请已提交",
"schema": {
"$ref": "#/definitions/responses.TransactionResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/my/subscriptions": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取当前用户的订阅列表",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"我的订阅"
],
"summary": "获取我的订阅列表",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "每页数量",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"description": "订阅状态",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "排序字段",
"name": "sort_by",
"in": "query"
},
{
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "排序方向",
"name": "sort_order",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取订阅列表成功",
"schema": {
"$ref": "#/definitions/responses.SubscriptionListResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/my/subscriptions/stats": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取当前用户的订阅统计信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"我的订阅"
],
"summary": "获取我的订阅统计",
"responses": {
"200": {
"description": "获取订阅统计成功",
"schema": {
"$ref": "#/definitions/responses.SubscriptionStatsResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/my/subscriptions/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取指定订阅的详细信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"我的订阅"
],
"summary": "获取我的订阅详情",
"parameters": [
{
"type": "string",
"description": "订阅ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "获取订阅详情成功",
"schema": {
"$ref": "#/definitions/responses.SubscriptionInfoResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "订阅不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/my/subscriptions/{id}/usage": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取指定订阅的使用情况统计",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"我的订阅"
],
"summary": "获取我的订阅使用情况",
"parameters": [
{
"type": "string",
"description": "订阅ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "获取使用情况成功",
"schema": {
"$ref": "#/definitions/responses.SubscriptionUsageResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "订阅不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/products": {
"get": {
"description": "分页获取可用的产品列表,支持筛选",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"数据大厅"
],
"summary": "获取产品列表",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "每页数量",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"description": "搜索关键词",
"name": "keyword",
"in": "query"
},
{
"type": "string",
"description": "分类ID",
"name": "category_id",
"in": "query"
},
{
"type": "number",
"description": "最低价格",
"name": "min_price",
"in": "query"
},
{
"type": "number",
"description": "最高价格",
"name": "max_price",
"in": "query"
},
{
"type": "boolean",
"description": "是否启用",
"name": "is_enabled",
"in": "query"
},
{
"type": "boolean",
"description": "是否可见",
"name": "is_visible",
"in": "query"
},
{
"type": "boolean",
"description": "是否组合包",
"name": "is_package",
"in": "query"
},
{
"type": "string",
"description": "排序字段",
"name": "sort_by",
"in": "query"
},
{
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "排序方向",
"name": "sort_order",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取产品列表成功",
"schema": {
"$ref": "#/definitions/responses.ProductListResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/products/stats": {
"get": {
"description": "获取产品相关的统计信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"数据大厅"
],
"summary": "获取产品统计",
"responses": {
"200": {
"description": "获取统计信息成功",
"schema": {
"$ref": "#/definitions/responses.ProductStatsResponse"
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/products/{id}": {
"get": {
"description": "根据产品ID获取产品详细信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"数据大厅"
],
"summary": "获取产品详情",
"parameters": [
{
"type": "string",
"description": "产品ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "获取产品详情成功",
"schema": {
"$ref": "#/definitions/responses.ProductInfoResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "产品不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/products/{id}/subscribe": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "用户订阅指定产品",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"数据大厅"
],
"summary": "订阅产品",
"parameters": [
{
"type": "string",
"description": "产品ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "订阅请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.CreateSubscriptionCommand"
}
}
],
"responses": {
"200": {
"description": "订阅成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "产品不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/users/login-password": {
"post": {
"description": "使用手机号和密码进行用户登录返回JWT令牌",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户认证"
],
"summary": "用户密码登录",
"parameters": [
{
"description": "密码登录请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.LoginWithPasswordCommand"
}
}
],
"responses": {
"200": {
"description": "登录成功",
"schema": {
"$ref": "#/definitions/responses.LoginUserResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "用户名或密码错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/users/login-sms": {
"post": {
"description": "使用手机号和短信验证码进行用户登录返回JWT令牌",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户认证"
],
"summary": "用户短信验证码登录",
"parameters": [
{
"description": "短信登录请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.LoginWithSMSCommand"
}
}
],
"responses": {
"200": {
"description": "登录成功",
"schema": {
"$ref": "#/definitions/responses.LoginUserResponse"
}
},
"400": {
"description": "请求参数错误或验证码无效",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "认证失败",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/users/me": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "根据JWT令牌获取当前登录用户的详细信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户管理"
],
"summary": "获取当前用户信息",
"responses": {
"200": {
"description": "用户信息",
"schema": {
"$ref": "#/definitions/responses.UserProfileResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "用户不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/users/me/password": {
"put": {
"security": [
{
"Bearer": []
}
],
"description": "使用旧密码、新密码确认和验证码修改当前用户的密码",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户管理"
],
"summary": "修改密码",
"parameters": [
{
"description": "修改密码请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.ChangePasswordCommand"
}
}
],
"responses": {
"200": {
"description": "密码修改成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误或验证码无效",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/users/register": {
"post": {
"description": "使用手机号、密码和验证码进行用户注册,需要确认密码",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户认证"
],
"summary": "用户注册",
"parameters": [
{
"description": "用户注册请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.RegisterUserCommand"
}
}
],
"responses": {
"201": {
"description": "注册成功",
"schema": {
"$ref": "#/definitions/responses.RegisterUserResponse"
}
},
"400": {
"description": "请求参数错误或验证码无效",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"409": {
"description": "手机号已存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/users/reset-password": {
"post": {
"description": "使用手机号、验证码和新密码重置用户密码(忘记密码时使用)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户认证"
],
"summary": "重置密码",
"parameters": [
{
"description": "重置密码请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.ResetPasswordCommand"
}
}
],
"responses": {
"200": {
"description": "密码重置成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误或验证码无效",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "用户不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/users/send-code": {
"post": {
"description": "向指定手机号发送验证码,支持注册、登录、修改密码等场景",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户认证"
],
"summary": "发送短信验证码",
"parameters": [
{
"description": "发送验证码请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.SendCodeCommand"
}
}
],
"responses": {
"200": {
"description": "验证码发送成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"429": {
"description": "请求频率限制",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
}
},
"definitions": {
"commands.AdminLoginCommand": {
"type": "object",
"required": [
"password",
"username"
],
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"commands.ChangeAdminPasswordCommand": {
"type": "object",
"required": [
"new_password",
"old_password"
],
"properties": {
"new_password": {
"type": "string"
},
"old_password": {
"type": "string"
}
}
},
"commands.ChangePasswordCommand": {
"description": "修改用户密码请求参数",
"type": "object",
"required": [
"code",
"confirm_new_password",
"new_password",
"old_password"
],
"properties": {
"code": {
"type": "string",
"example": "123456"
},
"confirm_new_password": {
"type": "string",
"example": "newpassword123"
},
"new_password": {
"type": "string",
"maxLength": 128,
"minLength": 6,
"example": "newpassword123"
},
"old_password": {
"type": "string",
"example": "oldpassword123"
}
}
},
"commands.CreateAdminCommand": {
"type": "object",
"required": [
"email",
"password",
"real_name",
"role",
"username"
],
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"phone": {
"type": "string"
},
"real_name": {
"type": "string"
},
"role": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"commands.CreateSubscriptionCommand": {
"type": "object",
"required": [
"product_id",
"user_id"
],
"properties": {
"api_limit": {
"type": "integer"
},
"auto_renew": {
"type": "boolean"
},
"duration": {
"type": "string"
},
"price": {
"type": "number",
"minimum": 0
},
"product_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"commands.CreateUserSecretsCommand": {
"type": "object",
"required": [
"user_id"
],
"properties": {
"expires_at": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"commands.CreateWalletCommand": {
"type": "object",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "string"
}
}
},
"commands.InitiateFaceVerifyCommand": {
"type": "object",
"required": [
"id_card_number",
"real_name",
"return_url"
],
"properties": {
"id_card_number": {
"type": "string"
},
"real_name": {
"type": "string"
},
"return_url": {
"type": "string"
}
}
},
"commands.LoginWithPasswordCommand": {
"description": "使用密码进行用户登录请求参数",
"type": "object",
"required": [
"password",
"phone"
],
"properties": {
"password": {
"type": "string",
"example": "password123"
},
"phone": {
"type": "string",
"example": "13800138000"
}
}
},
"commands.LoginWithSMSCommand": {
"description": "使用短信验证码进行用户登录请求参数",
"type": "object",
"required": [
"code",
"phone"
],
"properties": {
"code": {
"type": "string",
"example": "123456"
},
"phone": {
"type": "string",
"example": "13800138000"
}
}
},
"commands.RechargeWalletCommand": {
"type": "object",
"required": [
"amount",
"user_id"
],
"properties": {
"amount": {
"type": "number"
},
"user_id": {
"type": "string"
}
}
},
"commands.RegisterUserCommand": {
"description": "用户注册请求参数",
"type": "object",
"required": [
"code",
"confirm_password",
"password",
"phone"
],
"properties": {
"code": {
"type": "string",
"example": "123456"
},
"confirm_password": {
"type": "string",
"example": "password123"
},
"password": {
"type": "string",
"maxLength": 128,
"minLength": 6,
"example": "password123"
},
"phone": {
"type": "string",
"example": "13800138000"
}
}
},
"commands.ResetPasswordCommand": {
"description": "重置用户密码请求参数(忘记密码时使用)",
"type": "object",
"required": [
"code",
"confirm_new_password",
"new_password",
"phone"
],
"properties": {
"code": {
"type": "string",
"example": "123456"
},
"confirm_new_password": {
"type": "string",
"example": "newpassword123"
},
"new_password": {
"type": "string",
"maxLength": 128,
"minLength": 6,
"example": "newpassword123"
},
"phone": {
"type": "string",
"example": "13800138000"
}
}
},
"commands.SendCodeCommand": {
"description": "发送短信验证码请求参数",
"type": "object",
"required": [
"phone",
"scene"
],
"properties": {
"phone": {
"type": "string",
"example": "13800138000"
},
"scene": {
"type": "string",
"enum": [
"register",
"login",
"change_password",
"reset_password",
"bind",
"unbind"
],
"example": "register"
}
}
},
"commands.SubmitEnterpriseInfoCommand": {
"type": "object",
"required": [
"company_name",
"legal_person_id",
"legal_person_name",
"license_upload_record_id",
"unified_social_code"
],
"properties": {
"company_name": {
"type": "string"
},
"legal_person_id": {
"type": "string"
},
"legal_person_name": {
"type": "string"
},
"license_upload_record_id": {
"type": "string"
},
"unified_social_code": {
"type": "string"
}
}
},
"commands.UpdateAdminCommand": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"phone": {
"type": "string"
},
"real_name": {
"type": "string"
},
"role": {
"type": "string"
}
}
},
"commands.UpdateWalletCommand": {
"type": "object",
"required": [
"user_id"
],
"properties": {
"balance": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"user_id": {
"type": "string"
}
}
},
"commands.WalletTransactionCommand": {
"type": "object",
"required": [
"amount",
"from_user_id",
"to_user_id",
"user_id"
],
"properties": {
"amount": {
"type": "number"
},
"from_user_id": {
"type": "string"
},
"notes": {
"type": "string"
},
"to_user_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"commands.WithdrawWalletCommand": {
"type": "object",
"required": [
"amount",
"user_id"
],
"properties": {
"amount": {
"type": "number"
},
"user_id": {
"type": "string"
}
}
},
"entities.AdminRole": {
"type": "string",
"enum": [
"super_admin",
"admin",
"reviewer"
],
"x-enum-comments": {
"RoleAdmin": "普通管理员 - 拥有大部分管理权限",
"RoleReviewer": "审核员 - 仅拥有审核相关权限",
"RoleSuperAdmin": "超级管理员 - 拥有所有权限"
},
"x-enum-varnames": [
"RoleSuperAdmin",
"RoleAdmin",
"RoleReviewer"
]
},
"enums.CertificationStatus": {
"type": "string",
"enum": [
"not_started",
"pending",
"info_submitted",
"face_verified",
"contract_applied",
"contract_pending",
"contract_approved",
"contract_signed",
"completed",
"face_failed",
"sign_failed",
"rejected"
],
"x-enum-comments": {
"StatusCompleted": "认证完成",
"StatusContractApplied": "已申请合同",
"StatusContractApproved": "合同已审核(有链接)",
"StatusContractPending": "合同待审核",
"StatusContractSigned": "合同已签署",
"StatusFaceFailed": "人脸识别失败",
"StatusFaceVerified": "人脸识别完成",
"StatusInfoSubmitted": "企业信息已提交",
"StatusNotStarted": "未开始认证",
"StatusPending": "待开始",
"StatusRejected": "已拒绝",
"StatusSignFailed": "签署失败"
},
"x-enum-varnames": [
"StatusNotStarted",
"StatusPending",
"StatusInfoSubmitted",
"StatusFaceVerified",
"StatusContractApplied",
"StatusContractPending",
"StatusContractApproved",
"StatusContractSigned",
"StatusCompleted",
"StatusFaceFailed",
"StatusSignFailed",
"StatusRejected"
]
},
"internal_application_certification_dto_responses.EnterpriseInfoResponse": {
"type": "object",
"properties": {
"certification_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"is_face_verified": {
"type": "boolean"
},
"is_ocr_verified": {
"type": "boolean"
},
"legal_person_id": {
"type": "string"
},
"legal_person_name": {
"type": "string"
},
"license_upload_record_id": {
"type": "string"
},
"unified_social_code": {
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"internal_application_user_dto_responses.EnterpriseInfoResponse": {
"description": "企业信息响应",
"type": "object",
"properties": {
"certified_at": {
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"company_name": {
"type": "string",
"example": "示例企业有限公司"
},
"created_at": {
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"is_certified": {
"type": "boolean",
"example": false
},
"is_face_verified": {
"type": "boolean",
"example": false
},
"is_ocr_verified": {
"type": "boolean",
"example": false
},
"legal_person_id": {
"type": "string",
"example": "110101199001011234"
},
"legal_person_name": {
"type": "string",
"example": "张三"
},
"unified_social_code": {
"type": "string",
"example": "91110000123456789X"
},
"updated_at": {
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
"responses.AdminInfoResponse": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"last_login_at": {
"type": "string"
},
"login_count": {
"type": "integer"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"phone": {
"type": "string"
},
"real_name": {
"type": "string"
},
"role": {
"$ref": "#/definitions/entities.AdminRole"
},
"username": {
"type": "string"
}
}
},
"responses.AdminListResponse": {
"type": "object",
"properties": {
"admins": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.AdminInfoResponse"
}
},
"page": {
"type": "integer"
},
"size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"responses.AdminLoginResponse": {
"type": "object",
"properties": {
"admin": {
"$ref": "#/definitions/responses.AdminInfoResponse"
},
"expires_at": {
"type": "string"
},
"token": {
"type": "string"
}
}
},
"responses.AdminStatsResponse": {
"type": "object",
"properties": {
"active_admins": {
"type": "integer"
},
"today_logins": {
"type": "integer"
},
"total_admins": {
"type": "integer"
},
"total_operations": {
"type": "integer"
}
}
},
"responses.CategoryInfoResponse": {
"type": "object",
"properties": {
"children": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.CategoryInfoResponse"
}
},
"code": {
"type": "string"
},
"created_at": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"is_enabled": {
"type": "boolean"
},
"is_visible": {
"type": "boolean"
},
"level": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent": {
"description": "关联信息",
"allOf": [
{
"$ref": "#/definitions/responses.CategoryInfoResponse"
}
]
},
"parent_id": {
"type": "string"
},
"sort": {
"type": "integer"
},
"updated_at": {
"type": "string"
}
}
},
"responses.CategoryListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.CategoryInfoResponse"
}
},
"page": {
"type": "integer"
},
"size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"responses.CertificationResponse": {
"type": "object",
"properties": {
"completed_at": {
"type": "string"
},
"contract_applied_at": {
"type": "string"
},
"contract_approved_at": {
"type": "string"
},
"contract_signed_at": {
"type": "string"
},
"contract_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"enterprise": {
"$ref": "#/definitions/internal_application_certification_dto_responses.EnterpriseInfoResponse"
},
"face_verified_at": {
"type": "string"
},
"id": {
"type": "string"
},
"info_submitted_at": {
"type": "string"
},
"is_admin_action_required": {
"type": "boolean"
},
"is_user_action_required": {
"type": "boolean"
},
"progress": {
"type": "integer"
},
"reject_reason": {
"type": "string"
},
"signing_url": {
"type": "string"
},
"status": {
"$ref": "#/definitions/enums.CertificationStatus"
},
"status_name": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"responses.FaceVerifyResponse": {
"type": "object",
"properties": {
"certify_id": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"verify_url": {
"type": "string"
}
}
},
"responses.LoginUserResponse": {
"description": "用户登录成功响应",
"type": "object",
"properties": {
"access_token": {
"type": "string",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
},
"expires_in": {
"type": "integer",
"example": 86400
},
"login_method": {
"type": "string",
"example": "password"
},
"token_type": {
"type": "string",
"example": "Bearer"
},
"user": {
"$ref": "#/definitions/responses.UserProfileResponse"
}
}
},
"responses.ProductInfoResponse": {
"type": "object",
"properties": {
"category": {
"description": "关联信息",
"allOf": [
{
"$ref": "#/definitions/responses.CategoryInfoResponse"
}
]
},
"category_id": {
"type": "string"
},
"code": {
"type": "string"
},
"content": {
"type": "string"
},
"created_at": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"is_enabled": {
"type": "boolean"
},
"is_package": {
"type": "boolean"
},
"is_visible": {
"type": "boolean"
},
"name": {
"type": "string"
},
"price": {
"type": "number"
},
"seo_description": {
"type": "string"
},
"seo_keywords": {
"type": "string"
},
"seo_title": {
"description": "SEO信息",
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"responses.ProductListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.ProductInfoResponse"
}
},
"page": {
"type": "integer"
},
"size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"responses.ProductSimpleResponse": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"is_package": {
"type": "boolean"
},
"name": {
"type": "string"
},
"price": {
"type": "number"
}
}
},
"responses.ProductStatsResponse": {
"type": "object",
"properties": {
"enabled_products": {
"type": "integer"
},
"package_products": {
"type": "integer"
},
"total_products": {
"type": "integer"
},
"visible_products": {
"type": "integer"
}
}
},
"responses.RegisterUserResponse": {
"description": "用户注册成功响应",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"phone": {
"type": "string",
"example": "13800138000"
}
}
},
"responses.SubscriptionInfoResponse": {
"type": "object",
"properties": {
"api_used": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"price": {
"type": "number"
},
"product": {
"description": "关联信息",
"allOf": [
{
"$ref": "#/definitions/responses.ProductSimpleResponse"
}
]
},
"product_id": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"responses.SubscriptionListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.SubscriptionInfoResponse"
}
},
"page": {
"type": "integer"
},
"size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"responses.SubscriptionStatsResponse": {
"type": "object",
"properties": {
"total_revenue": {
"type": "number"
},
"total_subscriptions": {
"type": "integer"
}
}
},
"responses.SubscriptionUsageResponse": {
"type": "object",
"properties": {
"api_used": {
"type": "integer"
},
"id": {
"type": "string"
},
"product_id": {
"type": "string"
}
}
},
"responses.TransactionResponse": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"created_at": {
"type": "string"
},
"from_balance": {
"type": "number"
},
"from_user_id": {
"type": "string"
},
"notes": {
"type": "string"
},
"to_balance": {
"type": "number"
},
"to_user_id": {
"type": "string"
},
"transaction_id": {
"type": "string"
}
}
},
"responses.UploadLicenseResponse": {
"type": "object",
"properties": {
"credit_code": {
"type": "string"
},
"enterprise_name": {
"description": "OCR识别结果如果成功",
"type": "string"
},
"file_url": {
"type": "string"
},
"legal_person": {
"type": "string"
},
"ocr_confidence": {
"type": "number"
},
"ocr_error_message": {
"type": "string"
},
"ocr_processed": {
"type": "boolean"
},
"ocr_success": {
"type": "boolean"
},
"upload_record_id": {
"type": "string"
}
}
},
"responses.UserProfileResponse": {
"description": "用户基本信息",
"type": "object",
"properties": {
"created_at": {
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"enterprise_info": {
"$ref": "#/definitions/internal_application_user_dto_responses.EnterpriseInfoResponse"
},
"id": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"is_certified": {
"type": "boolean",
"example": false
},
"phone": {
"type": "string",
"example": "13800138000"
},
"updated_at": {
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
"responses.UserSecretsResponse": {
"type": "object",
"properties": {
"access_id": {
"type": "string"
},
"access_key": {
"type": "string"
},
"created_at": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"last_used_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"responses.WalletResponse": {
"type": "object",
"properties": {
"balance": {
"type": "number"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"responses.WalletStatsResponse": {
"type": "object",
"properties": {
"active_wallets": {
"type": "integer"
},
"today_transactions": {
"type": "integer"
},
"today_volume": {
"type": "number"
},
"total_balance": {
"type": "number"
},
"total_wallets": {
"type": "integer"
}
}
}
},
"securityDefinitions": {
"Bearer": {
"description": "Type \"Bearer\" followed by a space and JWT token.",
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "1.0",
Host: "localhost:8080",
BasePath: "/",
Schemes: []string{},
Title: "TYAPI Server API",
Description: "基于DDD和Clean Architecture的企业级后端API服务\n采用Gin框架构建支持用户管理、JWT认证、事件驱动等功能",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",
RightDelim: "}}",
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}