4296 lines
144 KiB
Go
4296 lines
144 KiB
Go
// 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/product-categories": {
|
||
"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"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "获取分类列表成功",
|
||
"schema": {
|
||
"$ref": "#/definitions/responses.CategoryListResponse"
|
||
}
|
||
},
|
||
"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.CreateCategoryCommand"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"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/product-categories/{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.CategoryInfoResponse"
|
||
}
|
||
},
|
||
"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.UpdateCategoryCommand"
|
||
}
|
||
}
|
||
],
|
||
"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
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"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
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "分类不存在",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "服务器内部错误",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/products": {
|
||
"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": "keyword",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "分类ID",
|
||
"name": "category_id",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "产品状态",
|
||
"name": "status",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "获取产品列表成功",
|
||
"schema": {
|
||
"$ref": "#/definitions/responses.ProductListResponse"
|
||
}
|
||
},
|
||
"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.CreateProductCommand"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"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/products/{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.ProductInfoResponse"
|
||
}
|
||
},
|
||
"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.UpdateProductCommand"
|
||
}
|
||
}
|
||
],
|
||
"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
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"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
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "产品不存在",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "服务器内部错误",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/admin/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"
|
||
}
|
||
],
|
||
"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/admin/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/admin/subscriptions/{id}/price": {
|
||
"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.UpdateSubscriptionPriceCommand"
|
||
}
|
||
}
|
||
],
|
||
"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/categories": {
|
||
"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": "boolean",
|
||
"description": "是否启用",
|
||
"name": "is_enabled",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "boolean",
|
||
"description": "是否可见",
|
||
"name": "is_visible",
|
||
"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/certifications": {
|
||
"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": "sort_by",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"enum": [
|
||
"asc",
|
||
"desc"
|
||
],
|
||
"type": "string",
|
||
"description": "排序方向",
|
||
"name": "sort_order",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "认证状态",
|
||
"name": "status",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "用户ID",
|
||
"name": "user_id",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "公司名称",
|
||
"name": "company_name",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "法人姓名",
|
||
"name": "legal_person_name",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "搜索关键词",
|
||
"name": "search_keyword",
|
||
"in": "query"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "获取认证列表成功",
|
||
"schema": {
|
||
"$ref": "#/definitions/responses.CertificationListResponse"
|
||
}
|
||
},
|
||
"401": {
|
||
"description": "未认证",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "权限不足",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "服务器内部错误",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/certifications/apply-contract": {
|
||
"post": {
|
||
"security": [
|
||
{
|
||
"Bearer": []
|
||
}
|
||
],
|
||
"description": "申请企业认证合同签署",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"认证管理"
|
||
],
|
||
"summary": "申请合同签署",
|
||
"parameters": [
|
||
{
|
||
"description": "申请合同请求",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/commands.ApplyContractCommand"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "合同申请成功",
|
||
"schema": {
|
||
"$ref": "#/definitions/responses.ContractSignUrlResponse"
|
||
}
|
||
},
|
||
"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/certifications/callbacks": {
|
||
"post": {
|
||
"description": "处理e签宝的企业认证和合同签署回调",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"认证管理"
|
||
],
|
||
"summary": "处理e签宝回调",
|
||
"parameters": [
|
||
{
|
||
"description": "e签宝回调数据",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/commands.EsignCallbackCommand"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "回调处理成功",
|
||
"schema": {
|
||
"$ref": "#/definitions/responses.CallbackResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "请求参数错误",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "服务器内部错误",
|
||
"schema": {
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v1/certifications/details": {
|
||
"get": {
|
||
"security": [
|
||
{
|
||
"Bearer": []
|
||
}
|
||
],
|
||
"description": "根据认证ID获取认证详情",
|
||
"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/certifications/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
|
||
}
|
||
},
|
||
"404": {
|
||
"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
|
||
}
|
||
],
|
||
"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.ApplyContractCommand": {
|
||
"type": "object",
|
||
"required": [
|
||
"certification_id",
|
||
"user_id"
|
||
],
|
||
"properties": {
|
||
"certification_id": {
|
||
"type": "string"
|
||
},
|
||
"user_id": {
|
||
"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",
|
||
"example": "NewPassword123"
|
||
},
|
||
"old_password": {
|
||
"type": "string",
|
||
"maxLength": 128,
|
||
"minLength": 6,
|
||
"example": "OldPassword123"
|
||
}
|
||
}
|
||
},
|
||
"commands.CreateCategoryCommand": {
|
||
"type": "object",
|
||
"required": [
|
||
"code",
|
||
"name"
|
||
],
|
||
"properties": {
|
||
"code": {
|
||
"type": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"maxLength": 200
|
||
},
|
||
"is_enabled": {
|
||
"type": "boolean"
|
||
},
|
||
"is_visible": {
|
||
"type": "boolean"
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"maxLength": 50,
|
||
"minLength": 2
|
||
},
|
||
"sort": {
|
||
"type": "integer",
|
||
"maximum": 9999,
|
||
"minimum": 0
|
||
}
|
||
}
|
||
},
|
||
"commands.CreateProductCommand": {
|
||
"type": "object",
|
||
"required": [
|
||
"category_id",
|
||
"code",
|
||
"name"
|
||
],
|
||
"properties": {
|
||
"category_id": {
|
||
"type": "string"
|
||
},
|
||
"code": {
|
||
"type": "string"
|
||
},
|
||
"content": {
|
||
"type": "string",
|
||
"maxLength": 5000
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"maxLength": 500
|
||
},
|
||
"is_enabled": {
|
||
"type": "boolean"
|
||
},
|
||
"is_package": {
|
||
"type": "boolean"
|
||
},
|
||
"is_visible": {
|
||
"type": "boolean"
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"maxLength": 100,
|
||
"minLength": 2
|
||
},
|
||
"price": {
|
||
"type": "number",
|
||
"minimum": 0
|
||
},
|
||
"seo_description": {
|
||
"type": "string",
|
||
"maxLength": 200
|
||
},
|
||
"seo_keywords": {
|
||
"type": "string",
|
||
"maxLength": 200
|
||
},
|
||
"seo_title": {
|
||
"description": "SEO信息",
|
||
"type": "string",
|
||
"maxLength": 100
|
||
}
|
||
}
|
||
},
|
||
"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.EsignCallbackCommand": {
|
||
"type": "object",
|
||
"required": [
|
||
"callback_type",
|
||
"certification_id",
|
||
"raw_data"
|
||
],
|
||
"properties": {
|
||
"callback_type": {
|
||
"type": "string",
|
||
"enum": [
|
||
"auth_result",
|
||
"sign_result",
|
||
"flow_status"
|
||
]
|
||
},
|
||
"certification_id": {
|
||
"type": "string"
|
||
},
|
||
"headers": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"query_params": {
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"raw_data": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"commands.LoginWithPasswordCommand": {
|
||
"description": "使用密码进行用户登录请求参数",
|
||
"type": "object",
|
||
"required": [
|
||
"password",
|
||
"phone"
|
||
],
|
||
"properties": {
|
||
"password": {
|
||
"type": "string",
|
||
"maxLength": 128,
|
||
"minLength": 6,
|
||
"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",
|
||
"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",
|
||
"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",
|
||
"certification"
|
||
],
|
||
"example": "register"
|
||
}
|
||
}
|
||
},
|
||
"commands.SubmitEnterpriseInfoCommand": {
|
||
"type": "object",
|
||
"required": [
|
||
"company_name",
|
||
"legal_person_id",
|
||
"legal_person_name",
|
||
"legal_person_phone",
|
||
"unified_social_code",
|
||
"verification_code"
|
||
],
|
||
"properties": {
|
||
"company_name": {
|
||
"type": "string",
|
||
"maxLength": 100,
|
||
"minLength": 2
|
||
},
|
||
"legal_person_id": {
|
||
"type": "string"
|
||
},
|
||
"legal_person_name": {
|
||
"type": "string",
|
||
"maxLength": 20,
|
||
"minLength": 2
|
||
},
|
||
"legal_person_phone": {
|
||
"type": "string"
|
||
},
|
||
"unified_social_code": {
|
||
"type": "string"
|
||
},
|
||
"verification_code": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"commands.UpdateCategoryCommand": {
|
||
"type": "object",
|
||
"required": [
|
||
"code",
|
||
"name"
|
||
],
|
||
"properties": {
|
||
"code": {
|
||
"type": "string"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"maxLength": 200
|
||
},
|
||
"is_enabled": {
|
||
"type": "boolean"
|
||
},
|
||
"is_visible": {
|
||
"type": "boolean"
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"maxLength": 50,
|
||
"minLength": 2
|
||
},
|
||
"sort": {
|
||
"type": "integer",
|
||
"maximum": 9999,
|
||
"minimum": 0
|
||
}
|
||
}
|
||
},
|
||
"commands.UpdateProductCommand": {
|
||
"type": "object",
|
||
"required": [
|
||
"category_id",
|
||
"code",
|
||
"name"
|
||
],
|
||
"properties": {
|
||
"category_id": {
|
||
"type": "string"
|
||
},
|
||
"code": {
|
||
"type": "string"
|
||
},
|
||
"content": {
|
||
"type": "string",
|
||
"maxLength": 5000
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"maxLength": 500
|
||
},
|
||
"is_enabled": {
|
||
"type": "boolean"
|
||
},
|
||
"is_package": {
|
||
"type": "boolean"
|
||
},
|
||
"is_visible": {
|
||
"type": "boolean"
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"maxLength": 100,
|
||
"minLength": 2
|
||
},
|
||
"price": {
|
||
"type": "number",
|
||
"minimum": 0
|
||
},
|
||
"seo_description": {
|
||
"type": "string",
|
||
"maxLength": 200
|
||
},
|
||
"seo_keywords": {
|
||
"type": "string",
|
||
"maxLength": 200
|
||
},
|
||
"seo_title": {
|
||
"description": "SEO信息",
|
||
"type": "string",
|
||
"maxLength": 100
|
||
}
|
||
}
|
||
},
|
||
"commands.UpdateSubscriptionPriceCommand": {
|
||
"type": "object",
|
||
"properties": {
|
||
"price": {
|
||
"type": "number",
|
||
"minimum": 0
|
||
}
|
||
}
|
||
},
|
||
"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",
|
||
"maxLength": 200
|
||
},
|
||
"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"
|
||
}
|
||
}
|
||
},
|
||
"enums.CertificationStatus": {
|
||
"type": "string",
|
||
"enum": [
|
||
"pending",
|
||
"info_submitted",
|
||
"enterprise_verified",
|
||
"contract_applied",
|
||
"contract_signed",
|
||
"info_rejected",
|
||
"contract_rejected",
|
||
"contract_expired"
|
||
],
|
||
"x-enum-comments": {
|
||
"StatusContractApplied": "已申请签署合同",
|
||
"StatusContractExpired": "合同签署超时",
|
||
"StatusContractRejected": "合同被拒签",
|
||
"StatusContractSigned": "已签署合同",
|
||
"StatusEnterpriseVerified": "已企业认证",
|
||
"StatusInfoRejected": "企业信息被拒绝",
|
||
"StatusInfoSubmitted": "已提交企业信息",
|
||
"StatusPending": "待认证"
|
||
},
|
||
"x-enum-varnames": [
|
||
"StatusPending",
|
||
"StatusInfoSubmitted",
|
||
"StatusEnterpriseVerified",
|
||
"StatusContractApplied",
|
||
"StatusContractSigned",
|
||
"StatusInfoRejected",
|
||
"StatusContractRejected",
|
||
"StatusContractExpired"
|
||
]
|
||
},
|
||
"enums.FailureReason": {
|
||
"type": "string",
|
||
"enum": [
|
||
"enterprise_not_exists",
|
||
"enterprise_info_mismatch",
|
||
"enterprise_status_abnormal",
|
||
"legal_person_mismatch",
|
||
"esign_verification_failed",
|
||
"invalid_document",
|
||
"contract_rejected_by_user",
|
||
"contract_expired",
|
||
"sign_process_failed",
|
||
"contract_gen_failed",
|
||
"esign_flow_error",
|
||
"system_error",
|
||
"network_error",
|
||
"timeout",
|
||
"unknown_error"
|
||
],
|
||
"x-enum-comments": {
|
||
"FailureReasonContractExpired": "合同签署超时",
|
||
"FailureReasonContractGenFailed": "合同生成失败",
|
||
"FailureReasonContractRejectedByUser": "用户拒绝签署",
|
||
"FailureReasonEnterpriseInfoMismatch": "企业信息不匹配",
|
||
"FailureReasonEnterpriseNotExists": "企业不存在",
|
||
"FailureReasonEnterpriseStatusAbnormal": "企业状态异常",
|
||
"FailureReasonEsignFlowError": "e签宝流程错误",
|
||
"FailureReasonEsignVerificationFailed": "e签宝验证失败",
|
||
"FailureReasonInvalidDocument": "证件信息无效",
|
||
"FailureReasonLegalPersonMismatch": "法定代表人信息不匹配",
|
||
"FailureReasonNetworkError": "网络错误",
|
||
"FailureReasonSignProcessFailed": "签署流程失败",
|
||
"FailureReasonSystemError": "系统错误",
|
||
"FailureReasonTimeout": "操作超时",
|
||
"FailureReasonUnknownError": "未知错误"
|
||
},
|
||
"x-enum-varnames": [
|
||
"FailureReasonEnterpriseNotExists",
|
||
"FailureReasonEnterpriseInfoMismatch",
|
||
"FailureReasonEnterpriseStatusAbnormal",
|
||
"FailureReasonLegalPersonMismatch",
|
||
"FailureReasonEsignVerificationFailed",
|
||
"FailureReasonInvalidDocument",
|
||
"FailureReasonContractRejectedByUser",
|
||
"FailureReasonContractExpired",
|
||
"FailureReasonSignProcessFailed",
|
||
"FailureReasonContractGenFailed",
|
||
"FailureReasonEsignFlowError",
|
||
"FailureReasonSystemError",
|
||
"FailureReasonNetworkError",
|
||
"FailureReasonTimeout",
|
||
"FailureReasonUnknownError"
|
||
]
|
||
},
|
||
"responses.CallbackResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"callback_type": {
|
||
"type": "string"
|
||
},
|
||
"certification_id": {
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"new_status": {
|
||
"$ref": "#/definitions/enums.CertificationStatus"
|
||
},
|
||
"old_status": {
|
||
"$ref": "#/definitions/enums.CertificationStatus"
|
||
},
|
||
"processed_at": {
|
||
"type": "string"
|
||
},
|
||
"success": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"responses.CategoryInfoResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"type": "string"
|
||
},
|
||
"description": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"is_enabled": {
|
||
"type": "boolean"
|
||
},
|
||
"is_visible": {
|
||
"type": "boolean"
|
||
},
|
||
"name": {
|
||
"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.CategorySimpleResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"responses.CertificationListResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"items": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/responses.CertificationResponse"
|
||
}
|
||
},
|
||
"page": {
|
||
"type": "integer"
|
||
},
|
||
"page_size": {
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"type": "integer"
|
||
},
|
||
"total_pages": {
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"responses.CertificationResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"available_actions": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"can_retry": {
|
||
"type": "boolean"
|
||
},
|
||
"contract_applied_at": {
|
||
"type": "string"
|
||
},
|
||
"contract_info": {
|
||
"description": "合同信息",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/value_objects.ContractInfo"
|
||
}
|
||
]
|
||
},
|
||
"contract_signed_at": {
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"description": "时间戳",
|
||
"type": "string"
|
||
},
|
||
"enterprise_info": {
|
||
"description": "企业信息",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/value_objects.EnterpriseInfo"
|
||
}
|
||
]
|
||
},
|
||
"enterprise_verified_at": {
|
||
"type": "string"
|
||
},
|
||
"failure_message": {
|
||
"type": "string"
|
||
},
|
||
"failure_reason": {
|
||
"description": "失败信息",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/enums.FailureReason"
|
||
}
|
||
]
|
||
},
|
||
"failure_reason_name": {
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"type": "string"
|
||
},
|
||
"info_submitted_at": {
|
||
"type": "string"
|
||
},
|
||
"is_completed": {
|
||
"description": "业务状态",
|
||
"type": "boolean"
|
||
},
|
||
"is_failed": {
|
||
"type": "boolean"
|
||
},
|
||
"is_user_action_required": {
|
||
"type": "boolean"
|
||
},
|
||
"metadata": {
|
||
"description": "元数据",
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
},
|
||
"next_action": {
|
||
"description": "用户操作提示",
|
||
"type": "string"
|
||
},
|
||
"progress": {
|
||
"type": "integer"
|
||
},
|
||
"retry_count": {
|
||
"type": "integer"
|
||
},
|
||
"status": {
|
||
"$ref": "#/definitions/enums.CertificationStatus"
|
||
},
|
||
"status_name": {
|
||
"type": "string"
|
||
},
|
||
"updated_at": {
|
||
"type": "string"
|
||
},
|
||
"user_id": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"responses.ContractSignUrlResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"certification_id": {
|
||
"type": "string"
|
||
},
|
||
"contract_sign_url": {
|
||
"type": "string"
|
||
},
|
||
"contract_url": {
|
||
"type": "string"
|
||
},
|
||
"expire_at": {
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"next_action": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"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.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": {
|
||
"category": {
|
||
"$ref": "#/definitions/responses.CategorySimpleResponse"
|
||
},
|
||
"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.UserProfileResponse": {
|
||
"description": "用户基本信息",
|
||
"type": "object",
|
||
"properties": {
|
||
"created_at": {
|
||
"type": "string",
|
||
"example": "2024-01-01T00:00:00Z"
|
||
},
|
||
"enterprise_info": {
|
||
"$ref": "#/definitions/responses.EnterpriseInfoResponse"
|
||
},
|
||
"id": {
|
||
"type": "string",
|
||
"example": "123e4567-e89b-12d3-a456-426614174000"
|
||
},
|
||
"is_active": {
|
||
"type": "boolean",
|
||
"example": true
|
||
},
|
||
"is_certified": {
|
||
"type": "boolean",
|
||
"example": false
|
||
},
|
||
"last_login_at": {
|
||
"type": "string",
|
||
"example": "2024-01-01T00:00:00Z"
|
||
},
|
||
"login_count": {
|
||
"type": "integer",
|
||
"example": 10
|
||
},
|
||
"permissions": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"example": [
|
||
"['user:read'",
|
||
"'user:write']"
|
||
]
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"example": "13800138000"
|
||
},
|
||
"updated_at": {
|
||
"type": "string",
|
||
"example": "2024-01-01T00:00:00Z"
|
||
},
|
||
"user_type": {
|
||
"type": "string",
|
||
"example": "user"
|
||
},
|
||
"username": {
|
||
"type": "string",
|
||
"example": "admin"
|
||
}
|
||
}
|
||
},
|
||
"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"
|
||
}
|
||
}
|
||
},
|
||
"value_objects.ContractInfo": {
|
||
"type": "object",
|
||
"properties": {
|
||
"contract_file_id": {
|
||
"description": "合同基本信息",
|
||
"type": "string"
|
||
},
|
||
"contract_sign_url": {
|
||
"description": "合同签署链接",
|
||
"type": "string"
|
||
},
|
||
"contract_title": {
|
||
"description": "合同元数据",
|
||
"type": "string"
|
||
},
|
||
"contract_url": {
|
||
"description": "合同文件访问链接",
|
||
"type": "string"
|
||
},
|
||
"contract_version": {
|
||
"description": "合同版本",
|
||
"type": "string"
|
||
},
|
||
"esign_flow_id": {
|
||
"description": "e签宝签署流程ID",
|
||
"type": "string"
|
||
},
|
||
"expires_at": {
|
||
"description": "签署链接过期时间",
|
||
"type": "string"
|
||
},
|
||
"generated_at": {
|
||
"description": "时间信息",
|
||
"type": "string"
|
||
},
|
||
"metadata": {
|
||
"description": "附加信息",
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
},
|
||
"sign_flow_created_at": {
|
||
"description": "签署流程创建时间",
|
||
"type": "string"
|
||
},
|
||
"sign_progress": {
|
||
"description": "签署进度",
|
||
"type": "integer"
|
||
},
|
||
"signed_at": {
|
||
"description": "签署完成时间",
|
||
"type": "string"
|
||
},
|
||
"signer_account": {
|
||
"description": "签署相关信息",
|
||
"type": "string"
|
||
},
|
||
"signer_name": {
|
||
"description": "签署人姓名",
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"description": "状态信息",
|
||
"type": "string"
|
||
},
|
||
"template_id": {
|
||
"description": "模板ID",
|
||
"type": "string"
|
||
},
|
||
"transactor_id_card_num": {
|
||
"description": "经办人身份证号",
|
||
"type": "string"
|
||
},
|
||
"transactor_name": {
|
||
"description": "经办人姓名",
|
||
"type": "string"
|
||
},
|
||
"transactor_phone": {
|
||
"description": "经办人手机号",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"value_objects.EnterpriseInfo": {
|
||
"type": "object",
|
||
"properties": {
|
||
"business_scope": {
|
||
"description": "经营范围",
|
||
"type": "string"
|
||
},
|
||
"company_name": {
|
||
"description": "企业基本信息",
|
||
"type": "string"
|
||
},
|
||
"establishment_date": {
|
||
"description": "成立日期",
|
||
"type": "string"
|
||
},
|
||
"legal_person_id": {
|
||
"description": "法定代表人身份证号",
|
||
"type": "string"
|
||
},
|
||
"legal_person_name": {
|
||
"description": "法定代表人信息",
|
||
"type": "string"
|
||
},
|
||
"legal_person_phone": {
|
||
"description": "法定代表人手机号",
|
||
"type": "string"
|
||
},
|
||
"registered_address": {
|
||
"description": "企业详细信息",
|
||
"type": "string"
|
||
},
|
||
"registered_capital": {
|
||
"description": "注册资本",
|
||
"type": "string"
|
||
},
|
||
"unified_social_code": {
|
||
"description": "统一社会信用代码",
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"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)
|
||
}
|