Files
tyapi-server/docs/swagger/swagger.json

3962 lines
133 KiB
JSON
Raw Normal View History

2025-07-02 16:17:59 +08:00
{
"swagger": "2.0",
"info": {
"description": "基于DDD和Clean Architecture的企业级后端API服务\n采用Gin框架构建支持用户管理、JWT认证、事件驱动等功能",
"title": "TYAPI Server API",
"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": "1.0"
},
"host": "localhost:8080",
2025-07-13 16:36:20 +08:00
"basePath": "/",
2025-07-02 16:17:59 +08:00
"paths": {
2025-07-20 20:53:26 +08:00
"/api/v1/admin/product-categories": {
2025-07-13 16:36:20 +08:00
"get": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "管理员获取产品分类列表",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"分类管理"
2025-07-13 16:36:20 +08:00
],
2025-07-20 20:53:26 +08:00
"summary": "获取分类列表",
2025-07-13 16:36:20 +08:00
"parameters": [
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "每页数量",
2025-07-20 20:53:26 +08:00
"name": "page_size",
2025-07-13 16:36:20 +08:00
"in": "query"
}
],
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "获取分类列表成功",
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"$ref": "#/definitions/responses.CategoryListResponse"
2025-07-13 16:36:20 +08:00
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
2025-07-02 16:17:59 +08:00
"post": {
2025-07-13 16:36:20 +08:00
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "管理员创建新产品分类",
2025-07-02 16:17:59 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"分类管理"
2025-07-02 16:17:59 +08:00
],
2025-07-20 20:53:26 +08:00
"summary": "创建分类",
2025-07-02 16:17:59 +08:00
"parameters": [
{
2025-07-20 20:53:26 +08:00
"description": "创建分类请求",
2025-07-02 16:17:59 +08:00
"name": "request",
"in": "body",
"required": true,
"schema": {
2025-07-20 20:53:26 +08:00
"$ref": "#/definitions/commands.CreateCategoryCommand"
2025-07-02 16:17:59 +08:00
}
}
],
"responses": {
2025-07-13 16:36:20 +08:00
"201": {
2025-07-20 20:53:26 +08:00
"description": "分类创建成功",
2025-07-02 16:17:59 +08:00
"schema": {
2025-07-13 16:36:20 +08:00
"type": "object",
"additionalProperties": true
2025-07-02 16:17:59 +08:00
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-13 16:36:20 +08:00
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-20 20:53:26 +08:00
"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": "分类不存在",
2025-07-02 16:17:59 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
2025-07-20 20:53:26 +08:00
},
"put": {
"security": [
{
"Bearer": []
}
],
"description": "管理员更新产品分类信息",
2025-07-02 16:17:59 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"分类管理"
2025-07-02 16:17:59 +08:00
],
2025-07-20 20:53:26 +08:00
"summary": "更新分类",
2025-07-02 16:17:59 +08:00
"parameters": [
{
2025-07-20 20:53:26 +08:00
"type": "string",
"description": "分类ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "更新分类请求",
2025-07-02 16:17:59 +08:00
"name": "request",
"in": "body",
"required": true,
"schema": {
2025-07-20 20:53:26 +08:00
"$ref": "#/definitions/commands.UpdateCategoryCommand"
2025-07-02 16:17:59 +08:00
}
}
],
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "分类更新成功",
2025-07-02 16:17:59 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"type": "object",
"additionalProperties": true
2025-07-02 16:17:59 +08:00
}
},
"400": {
2025-07-13 16:36:20 +08:00
"description": "请求参数错误",
2025-07-02 16:17:59 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-20 20:53:26 +08:00
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "分类不存在",
2025-07-02 16:17:59 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
2025-07-20 20:53:26 +08:00
},
"delete": {
2025-07-02 16:17:59 +08:00
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "管理员删除产品分类",
2025-07-02 16:17:59 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"分类管理"
2025-07-13 16:36:20 +08:00
],
2025-07-20 20:53:26 +08:00
"summary": "删除分类",
2025-07-13 16:36:20 +08:00
"parameters": [
{
2025-07-20 20:53:26 +08:00
"type": "string",
"description": "分类ID",
"name": "id",
"in": "path",
"required": true
2025-07-13 16:36:20 +08:00
}
2025-07-02 16:17:59 +08:00
],
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "分类删除成功",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
2025-07-02 16:17:59 +08:00
"schema": {
2025-07-13 16:36:20 +08:00
"type": "object",
"additionalProperties": true
2025-07-02 16:17:59 +08:00
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-20 20:53:26 +08:00
"404": {
"description": "分类不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-13 16:36:20 +08:00
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/admin/products": {
2025-07-13 16:36:20 +08:00
"get": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "管理员获取产品列表,支持筛选",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"产品管理"
],
"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"
}
2025-07-13 16:36:20 +08:00
],
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "获取产品列表成功",
"schema": {
"$ref": "#/definitions/responses.ProductListResponse"
}
},
"400": {
"description": "请求参数错误",
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"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
2025-07-13 16:36:20 +08:00
}
},
"401": {
"description": "未认证",
2025-07-02 16:17:59 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/admin/products/{id}": {
2025-07-13 16:36:20 +08:00
"get": {
2025-07-02 16:17:59 +08:00
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "管理员获取产品详细信息",
2025-07-02 16:17:59 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"产品管理"
2025-07-02 16:17:59 +08:00
],
2025-07-20 20:53:26 +08:00
"summary": "获取产品详情",
2025-07-02 16:17:59 +08:00
"parameters": [
{
2025-07-13 16:36:20 +08:00
"type": "string",
2025-07-20 20:53:26 +08:00
"description": "产品ID",
2025-07-13 16:36:20 +08:00
"name": "id",
"in": "path",
"required": true
2025-07-02 16:17:59 +08:00
}
],
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "获取产品详情成功",
2025-07-02 16:17:59 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"$ref": "#/definitions/responses.ProductInfoResponse"
2025-07-02 16:17:59 +08:00
}
},
"400": {
2025-07-13 16:36:20 +08:00
"description": "请求参数错误",
2025-07-02 16:17:59 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-13 16:36:20 +08:00
"404": {
2025-07-20 20:53:26 +08:00
"description": "产品不存在",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-02 16:17:59 +08:00
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
2025-07-13 16:36:20 +08:00
},
"put": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "管理员更新产品信息",
2025-07-02 16:17:59 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"产品管理"
2025-07-02 16:17:59 +08:00
],
2025-07-20 20:53:26 +08:00
"summary": "更新产品",
2025-07-02 16:17:59 +08:00
"parameters": [
{
2025-07-13 16:36:20 +08:00
"type": "string",
2025-07-20 20:53:26 +08:00
"description": "产品ID",
2025-07-13 16:36:20 +08:00
"name": "id",
"in": "path",
"required": true
},
{
2025-07-20 20:53:26 +08:00
"description": "更新产品请求",
2025-07-02 16:17:59 +08:00
"name": "request",
"in": "body",
"required": true,
"schema": {
2025-07-20 20:53:26 +08:00
"$ref": "#/definitions/commands.UpdateProductCommand"
2025-07-02 16:17:59 +08:00
}
}
],
"responses": {
2025-07-13 16:36:20 +08:00
"200": {
2025-07-20 20:53:26 +08:00
"description": "产品更新成功",
2025-07-02 16:17:59 +08:00
"schema": {
2025-07-13 16:36:20 +08:00
"type": "object",
"additionalProperties": true
2025-07-02 16:17:59 +08:00
}
},
"400": {
2025-07-13 16:36:20 +08:00
"description": "请求参数错误",
2025-07-02 16:17:59 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-13 16:36:20 +08:00
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
2025-07-20 20:53:26 +08:00
"description": "产品不存在",
2025-07-02 16:17:59 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
2025-07-13 16:36:20 +08:00
},
"delete": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "管理员删除产品",
2025-07-02 16:17:59 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"产品管理"
2025-07-02 16:17:59 +08:00
],
2025-07-20 20:53:26 +08:00
"summary": "删除产品",
2025-07-02 16:17:59 +08:00
"parameters": [
{
2025-07-13 16:36:20 +08:00
"type": "string",
2025-07-20 20:53:26 +08:00
"description": "产品ID",
2025-07-13 16:36:20 +08:00
"name": "id",
"in": "path",
"required": true
2025-07-02 16:17:59 +08:00
}
],
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "产品删除成功",
2025-07-02 16:17:59 +08:00
"schema": {
2025-07-13 16:36:20 +08:00
"type": "object",
"additionalProperties": true
2025-07-02 16:17:59 +08:00
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-13 16:36:20 +08:00
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
2025-07-20 20:53:26 +08:00
"description": "产品不存在",
2025-07-02 16:17:59 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
2025-07-13 16:36:20 +08:00
},
2025-07-20 20:53:26 +08:00
"/api/v1/admin/subscriptions": {
2025-07-15 13:21:34 +08:00
"get": {
2025-07-20 20:53:26 +08:00
"security": [
{
"Bearer": []
}
],
"description": "管理员获取订阅列表",
2025-07-15 13:21:34 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"订阅管理"
2025-07-15 13:21:34 +08:00
],
2025-07-20 20:53:26 +08:00
"summary": "获取订阅列表",
2025-07-15 13:21:34 +08:00
"parameters": [
{
2025-07-20 20:53:26 +08:00
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
2025-07-15 13:21:34 +08:00
"in": "query"
},
{
"type": "integer",
2025-07-20 20:53:26 +08:00
"default": 10,
"description": "每页数量",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"description": "订阅状态",
"name": "status",
2025-07-15 13:21:34 +08:00
"in": "query"
}
],
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "获取订阅列表成功",
2025-07-15 13:21:34 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"$ref": "#/definitions/responses.SubscriptionListResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
2025-07-15 13:21:34 +08:00
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/admin/subscriptions/stats": {
2025-07-15 13:21:34 +08:00
"get": {
2025-07-20 20:53:26 +08:00
"security": [
{
"Bearer": []
}
],
"description": "管理员获取订阅统计信息",
2025-07-15 13:21:34 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"订阅管理"
2025-07-15 13:21:34 +08:00
],
2025-07-20 20:53:26 +08:00
"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": "更新订阅价格",
2025-07-15 13:21:34 +08:00
"parameters": [
{
"type": "string",
2025-07-20 20:53:26 +08:00
"description": "订阅ID",
2025-07-15 13:21:34 +08:00
"name": "id",
"in": "path",
"required": true
2025-07-20 20:53:26 +08:00
},
{
"description": "更新订阅价格请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.UpdateSubscriptionPriceCommand"
}
2025-07-15 13:21:34 +08:00
}
],
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "订阅价格更新成功",
2025-07-15 13:21:34 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"type": "object",
"additionalProperties": true
2025-07-15 13:21:34 +08:00
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-20 20:53:26 +08:00
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-15 13:21:34 +08:00
"404": {
2025-07-20 20:53:26 +08:00
"description": "订阅不存在",
2025-07-15 13:21:34 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/categories": {
"get": {
"description": "获取产品分类列表,支持筛选",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"数据大厅"
],
"summary": "获取分类列表",
"parameters": [
2025-07-13 16:36:20 +08:00
{
2025-07-20 20:53:26 +08:00
"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"
2025-07-13 16:36:20 +08:00
}
],
2025-07-20 20:53:26 +08:00
"responses": {
"200": {
"description": "获取分类列表成功",
"schema": {
"$ref": "#/definitions/responses.CategoryListResponse"
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/categories/{id}": {
"get": {
"description": "根据分类ID获取分类详细信息",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-20 20:53:26 +08:00
"数据大厅"
],
"summary": "获取分类详情",
"parameters": [
{
"type": "string",
"description": "分类ID",
"name": "id",
"in": "path",
"required": true
}
2025-07-13 16:36:20 +08:00
],
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "获取分类详情成功",
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"$ref": "#/definitions/responses.CategoryInfoResponse"
2025-07-13 16:36:20 +08:00
}
},
2025-07-20 20:53:26 +08:00
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "分类不存在",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/certification/apply-contract": {
2025-07-13 16:36:20 +08:00
"post": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "为企业认证用户申请合同,生成合同文档",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "申请合同",
"responses": {
"200": {
"description": "合同申请成功",
"schema": {
2025-07-20 20:53:26 +08:00
"type": "object",
"additionalProperties": true
2025-07-13 16:36:20 +08:00
}
},
"400": {
2025-07-20 20:53:26 +08:00
"description": "企业认证未完成或合同申请失败",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-20 20:53:26 +08:00
"description": "用户未登录",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/certification/complete-contract-sign": {
"post": {
2025-07-13 16:36:20 +08:00
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "完成合同签署流程提交合同URL系统会自动判断是否完成认证",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
2025-07-20 20:53:26 +08:00
"summary": "完成合同签署",
"parameters": [
{
"description": "合同签署完成请求",
"name": "request",
"in": "body",
"required": true,
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"$ref": "#/definitions/commands.CompleteContractSignCommand"
2025-07-13 16:36:20 +08:00
}
2025-07-20 20:53:26 +08:00
}
],
"responses": {
"200": {
"description": "合同签署完成",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-20 20:53:26 +08:00
"400": {
"description": "请求参数错误或签署状态异常",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-20 20:53:26 +08:00
"401": {
"description": "用户未登录",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/certification/complete-enterprise-auth": {
2025-07-13 16:36:20 +08:00
"post": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "完成企业认证流程,更新认证状态",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
2025-07-20 20:53:26 +08:00
"summary": "完成企业认证",
2025-07-13 16:36:20 +08:00
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "企业认证完成",
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"type": "object",
"additionalProperties": true
2025-07-13 16:36:20 +08:00
}
},
"400": {
2025-07-20 20:53:26 +08:00
"description": "认证状态异常或认证未完成",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-20 20:53:26 +08:00
"description": "用户未登录",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/certification/contract-sign-url": {
"get": {
2025-07-13 16:36:20 +08:00
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "获取e签宝合同签署链接用户可通过该链接完成合同签署",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
2025-07-20 20:53:26 +08:00
"tags": [
"企业认证"
2025-07-13 16:36:20 +08:00
],
2025-07-20 20:53:26 +08:00
"summary": "获取合同签署链接",
2025-07-13 16:36:20 +08:00
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "获取合同签署链接成功",
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"type": "object",
"additionalProperties": true
2025-07-13 16:36:20 +08:00
}
},
"400": {
2025-07-20 20:53:26 +08:00
"description": "合同未申请或签署状态异常",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-20 20:53:26 +08:00
"description": "用户未登录",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/certification/details": {
2025-07-13 16:36:20 +08:00
"get": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "获取当前用户的详细认证信息,包括企业信息、认证记录等",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
2025-07-20 20:53:26 +08:00
"summary": "获取认证详情",
2025-07-13 16:36:20 +08:00
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "获取认证详情成功",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-20 20:53:26 +08:00
"description": "用户未登录",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/certification/enterprise-auth-url": {
2025-07-13 16:36:20 +08:00
"get": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "获取e签宝企业认证链接用户可通过该链接完成企业认证",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
2025-07-20 20:53:26 +08:00
"summary": "获取企业认证链接",
2025-07-13 16:36:20 +08:00
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "获取企业认证链接成功",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
2025-07-20 20:53:26 +08:00
"description": "企业信息未提交或认证状态异常",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-20 20:53:26 +08:00
"description": "用户未登录",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/certification/esign-callback": {
2025-07-13 16:36:20 +08:00
"post": {
2025-07-20 20:53:26 +08:00
"description": "接收e签宝认证和签署的回调通知",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
2025-07-20 20:53:26 +08:00
"summary": "e签宝回调接口",
2025-07-13 16:36:20 +08:00
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "回调处理成功",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
2025-07-20 20:53:26 +08:00
"description": "回调参数错误",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/certification/progress": {
2025-07-13 16:36:20 +08:00
"get": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "获取当前用户的认证进度百分比和下一步操作提示",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
2025-07-20 20:53:26 +08:00
"summary": "获取认证进度",
2025-07-13 16:36:20 +08:00
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "获取认证进度成功",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-20 20:53:26 +08:00
"description": "用户未登录",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/certification/status": {
"get": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "获取当前用户的认证状态信息,包括认证进度、当前状态等",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"企业认证"
],
"summary": "获取认证状态",
"responses": {
"200": {
"description": "获取认证状态成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-20 20:53:26 +08:00
"description": "用户未登录",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-20 20:53:26 +08:00
"/api/v1/certification/submit-enterprise-info": {
2025-07-13 16:36:20 +08:00
"post": {
"security": [
{
"Bearer": []
}
],
2025-07-20 20:53:26 +08:00
"description": "提交企业四要素信息(企业名称、统一社会信用代码、法定代表人姓名、法定代表人身份证),完成企业信息验证。如果用户没有认证申请,系统会自动创建",
2025-07-13 16:36:20 +08:00
"consumes": [
2025-07-20 20:53:26 +08:00
"application/json"
2025-07-13 16:36:20 +08:00
],
"produces": [
"application/json"
],
"tags": [
2025-07-15 13:21:34 +08:00
"企业认证"
2025-07-13 16:36:20 +08:00
],
2025-07-20 20:53:26 +08:00
"summary": "提交企业信息",
2025-07-13 16:36:20 +08:00
"parameters": [
{
2025-07-20 20:53:26 +08:00
"description": "企业信息提交请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.SubmitEnterpriseInfoCommand"
}
2025-07-13 16:36:20 +08:00
}
],
"responses": {
"200": {
2025-07-20 20:53:26 +08:00
"description": "企业信息提交成功",
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-20 20:53:26 +08:00
"type": "object",
"additionalProperties": true
2025-07-13 16:36:20 +08:00
}
},
"400": {
2025-07-20 20:53:26 +08:00
"description": "请求参数错误或验证码无效",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-20 20:53:26 +08:00
"description": "用户未登录",
2025-07-13 16:36:20 +08:00
"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
}
}
}
}
},
2025-07-15 13:21:34 +08:00
"/api/v1/my/subscriptions": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取当前用户的订阅列表",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-15 13:21:34 +08:00
"我的订阅"
2025-07-13 16:36:20 +08:00
],
2025-07-15 13:21:34 +08:00
"summary": "获取我的订阅列表",
2025-07-13 16:36:20 +08:00
"parameters": [
{
2025-07-15 13:21:34 +08:00
"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"
2025-07-13 16:36:20 +08:00
}
],
"responses": {
"200": {
2025-07-15 13:21:34 +08:00
"description": "获取订阅列表成功",
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-15 13:21:34 +08:00
"$ref": "#/definitions/responses.SubscriptionListResponse"
2025-07-13 16:36:20 +08:00
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
2025-07-15 13:21:34 +08:00
"description": "未认证",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-15 13:21:34 +08:00
"/api/v1/my/subscriptions/stats": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取当前用户的订阅统计信息",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-15 13:21:34 +08:00
"我的订阅"
2025-07-13 16:36:20 +08:00
],
2025-07-15 13:21:34 +08:00
"summary": "获取我的订阅统计",
2025-07-13 16:36:20 +08:00
"responses": {
"200": {
2025-07-15 13:21:34 +08:00
"description": "获取订阅统计成功",
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-15 13:21:34 +08:00
"$ref": "#/definitions/responses.SubscriptionStatsResponse"
2025-07-13 16:36:20 +08:00
}
},
"401": {
2025-07-15 13:21:34 +08:00
"description": "未认证",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-15 13:21:34 +08:00
"/api/v1/my/subscriptions/{id}": {
2025-07-13 16:36:20 +08:00
"get": {
"security": [
{
"Bearer": []
}
],
2025-07-15 13:21:34 +08:00
"description": "获取指定订阅的详细信息",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-15 13:21:34 +08:00
"我的订阅"
],
"summary": "获取我的订阅详情",
"parameters": [
{
"type": "string",
"description": "订阅ID",
"name": "id",
"in": "path",
"required": true
}
2025-07-13 16:36:20 +08:00
],
"responses": {
"200": {
2025-07-15 13:21:34 +08:00
"description": "获取订阅详情成功",
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-15 13:21:34 +08:00
"$ref": "#/definitions/responses.SubscriptionInfoResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
2025-07-13 16:36:20 +08:00
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
2025-07-15 13:21:34 +08:00
"description": "订阅不存在",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-15 13:21:34 +08:00
"/api/v1/my/subscriptions/{id}/usage": {
"get": {
2025-07-13 16:36:20 +08:00
"security": [
{
"Bearer": []
}
],
2025-07-15 13:21:34 +08:00
"description": "获取指定订阅的使用情况统计",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-15 13:21:34 +08:00
"我的订阅"
2025-07-13 16:36:20 +08:00
],
2025-07-15 13:21:34 +08:00
"summary": "获取我的订阅使用情况",
2025-07-13 16:36:20 +08:00
"parameters": [
{
2025-07-15 13:21:34 +08:00
"type": "string",
"description": "订阅ID",
"name": "id",
"in": "path",
"required": true
2025-07-13 16:36:20 +08:00
}
],
"responses": {
"200": {
2025-07-15 13:21:34 +08:00
"description": "获取使用情况成功",
2025-07-13 16:36:20 +08:00
"schema": {
2025-07-15 13:21:34 +08:00
"$ref": "#/definitions/responses.SubscriptionUsageResponse"
2025-07-13 16:36:20 +08:00
}
},
"400": {
2025-07-15 13:21:34 +08:00
"description": "请求参数错误",
2025-07-13 16:36:20 +08:00
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-15 13:21:34 +08:00
"404": {
"description": "订阅不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
2025-07-13 16:36:20 +08:00
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
2025-07-15 13:21:34 +08:00
"/api/v1/products": {
"get": {
"description": "分页获取可用的产品列表,支持筛选",
2025-07-13 16:36:20 +08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2025-07-15 13:21:34 +08:00
"数据大厅"
2025-07-13 16:36:20 +08:00
],
2025-07-15 13:21:34 +08:00
"summary": "获取产品列表",
2025-07-13 16:36:20 +08:00
"parameters": [
{
2025-07-15 13:21:34 +08:00
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
2025-07-13 16:36:20 +08:00
},
2025-07-15 13:21:34 +08:00
{
"type": "integer",
"default": 10,
"description": "每页数量",
"name": "page_size",
"in": "query"
2025-07-13 16:36:20 +08:00
},
2025-07-15 13:21:34 +08:00
{
"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": "服务器内部错误",
2025-07-13 16:36:20 +08:00
"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.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",
2025-07-02 16:17:59 +08:00
"maxLength": 128,
"minLength": 6,
"example": "newpassword123"
},
2025-07-13 16:36:20 +08:00
"old_password": {
"type": "string",
"example": "oldpassword123"
}
}
},
2025-07-20 20:53:26 +08:00
"commands.CompleteContractSignCommand": {
2025-07-13 16:36:20 +08:00
"type": "object",
"required": [
2025-07-20 20:53:26 +08:00
"contract_url"
2025-07-13 16:36:20 +08:00
],
"properties": {
2025-07-20 20:53:26 +08:00
"contract_url": {
2025-07-13 16:36:20 +08:00
"type": "string"
2025-07-20 20:53:26 +08:00
}
}
},
"commands.CreateCategoryCommand": {
"type": "object",
"required": [
"code",
"name"
],
"properties": {
"code": {
2025-07-13 16:36:20 +08:00
"type": "string"
},
2025-07-20 20:53:26 +08:00
"description": {
2025-07-13 16:36:20 +08:00
"type": "string"
},
2025-07-20 20:53:26 +08:00
"is_enabled": {
"type": "boolean"
2025-07-13 16:36:20 +08:00
},
2025-07-20 20:53:26 +08:00
"is_visible": {
"type": "boolean"
2025-07-13 16:36:20 +08:00
},
2025-07-20 20:53:26 +08:00
"name": {
2025-07-13 16:36:20 +08:00
"type": "string"
2025-07-20 20:53:26 +08:00
},
"sort": {
"type": "integer"
2025-07-13 16:36:20 +08:00
}
}
},
2025-07-20 20:53:26 +08:00
"commands.CreateProductCommand": {
2025-07-15 13:21:34 +08:00
"type": "object",
"required": [
2025-07-20 20:53:26 +08:00
"category_id",
"code",
"name"
2025-07-15 13:21:34 +08:00
],
"properties": {
2025-07-20 20:53:26 +08:00
"category_id": {
"type": "string"
},
"code": {
"type": "string"
},
"content": {
"type": "string"
2025-07-15 13:21:34 +08:00
},
2025-07-20 20:53:26 +08:00
"description": {
"type": "string"
},
"is_enabled": {
"type": "boolean"
},
"is_package": {
"type": "boolean"
},
"is_visible": {
2025-07-15 13:21:34 +08:00
"type": "boolean"
},
2025-07-20 20:53:26 +08:00
"name": {
2025-07-15 13:21:34 +08:00
"type": "string"
},
"price": {
"type": "number",
"minimum": 0
},
2025-07-20 20:53:26 +08:00
"seo_description": {
2025-07-15 13:21:34 +08:00
"type": "string"
},
2025-07-20 20:53:26 +08:00
"seo_keywords": {
"type": "string"
},
"seo_title": {
"description": "SEO信息",
2025-07-15 13:21:34 +08:00
"type": "string"
}
}
},
2025-07-13 16:36:20 +08:00
"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.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"
}
}
},
2025-07-15 13:21:34 +08:00
"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"
}
}
},
2025-07-13 16:36:20 +08:00
"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",
2025-07-20 20:53:26 +08:00
"unbind",
"certification"
2025-07-13 16:36:20 +08:00
],
"example": "register"
}
}
},
"commands.SubmitEnterpriseInfoCommand": {
"type": "object",
"required": [
"company_name",
"legal_person_id",
"legal_person_name",
2025-07-20 20:53:26 +08:00
"legal_person_phone",
"unified_social_code",
"verification_code"
2025-07-13 16:36:20 +08:00
],
"properties": {
"company_name": {
"type": "string"
},
2025-07-20 20:53:26 +08:00
"legal_person_id": {
"type": "string"
},
"legal_person_name": {
"type": "string"
},
"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"
},
"is_enabled": {
"type": "boolean"
},
"is_visible": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sort": {
"type": "integer"
}
}
},
"commands.UpdateProductCommand": {
"type": "object",
"required": [
"category_id",
"code",
"name"
],
"properties": {
"category_id": {
"type": "string"
},
"code": {
"type": "string"
},
"content": {
"type": "string"
},
"description": {
"type": "string"
},
"is_enabled": {
"type": "boolean"
},
"is_package": {
"type": "boolean"
},
"is_visible": {
"type": "boolean"
},
"name": {
2025-07-13 16:36:20 +08:00
"type": "string"
},
2025-07-20 20:53:26 +08:00
"price": {
"type": "number",
"minimum": 0
},
"seo_description": {
2025-07-13 16:36:20 +08:00
"type": "string"
},
2025-07-20 20:53:26 +08:00
"seo_keywords": {
2025-07-13 16:36:20 +08:00
"type": "string"
},
2025-07-20 20:53:26 +08:00
"seo_title": {
"description": "SEO信息",
2025-07-13 16:36:20 +08:00
"type": "string"
}
}
},
2025-07-20 20:53:26 +08:00
"commands.UpdateSubscriptionPriceCommand": {
2025-07-13 16:36:20 +08:00
"type": "object",
"properties": {
2025-07-20 20:53:26 +08:00
"price": {
"type": "number",
"minimum": 0
2025-07-13 16:36:20 +08:00
}
}
},
"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"
}
}
},
"internal_application_user_dto_responses.EnterpriseInfoResponse": {
"description": "企业信息响应",
"type": "object",
"properties": {
"certified_at": {
2025-07-02 16:17:59 +08:00
"type": "string",
2025-07-13 16:36:20 +08:00
"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"
}
}
},
2025-07-15 13:21:34 +08:00
"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"
}
}
},
2025-07-20 20:53:26 +08:00
"responses.CategorySimpleResponse": {
2025-07-13 16:36:20 +08:00
"type": "object",
"properties": {
2025-07-20 20:53:26 +08:00
"code": {
2025-07-13 16:36:20 +08:00
"type": "string"
},
"id": {
"type": "string"
},
2025-07-20 20:53:26 +08:00
"name": {
2025-07-13 16:36:20 +08:00
"type": "string"
2025-07-02 16:17:59 +08:00
}
}
},
2025-07-13 16:36:20 +08:00
"responses.LoginUserResponse": {
"description": "用户登录成功响应",
2025-07-02 16:17:59 +08:00
"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": {
2025-07-13 16:36:20 +08:00
"$ref": "#/definitions/responses.UserProfileResponse"
2025-07-02 16:17:59 +08:00
}
}
},
2025-07-15 13:21:34 +08:00
"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": {
2025-07-20 20:53:26 +08:00
"category": {
"$ref": "#/definitions/responses.CategorySimpleResponse"
},
2025-07-15 13:21:34 +08:00
"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"
}
}
},
2025-07-13 16:36:20 +08:00
"responses.RegisterUserResponse": {
"description": "用户注册成功响应",
2025-07-02 16:17:59 +08:00
"type": "object",
"properties": {
2025-07-13 16:36:20 +08:00
"id": {
2025-07-02 16:17:59 +08:00
"type": "string",
2025-07-13 16:36:20 +08:00
"example": "123e4567-e89b-12d3-a456-426614174000"
2025-07-02 16:17:59 +08:00
},
"phone": {
"type": "string",
"example": "13800138000"
}
}
},
2025-07-15 13:21:34 +08:00
"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"
}
}
},
2025-07-13 16:36:20 +08:00
"responses.TransactionResponse": {
2025-07-02 16:17:59 +08:00
"type": "object",
"properties": {
2025-07-13 16:36:20 +08:00
"amount": {
"type": "number"
2025-07-02 16:17:59 +08:00
},
2025-07-13 16:36:20 +08:00
"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"
2025-07-02 16:17:59 +08:00
}
}
},
2025-07-13 16:36:20 +08:00
"responses.UserProfileResponse": {
"description": "用户基本信息",
2025-07-02 16:17:59 +08:00
"type": "object",
"properties": {
2025-07-13 16:36:20 +08:00
"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"
},
2025-07-20 20:53:26 +08:00
"is_active": {
"type": "boolean",
"example": true
},
2025-07-15 13:21:34 +08:00
"is_certified": {
"type": "boolean",
"example": false
},
2025-07-20 20:53:26 +08:00
"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']"
]
},
2025-07-02 16:17:59 +08:00
"phone": {
"type": "string",
"example": "13800138000"
},
2025-07-13 16:36:20 +08:00
"updated_at": {
"type": "string",
"example": "2024-01-01T00:00:00Z"
2025-07-20 20:53:26 +08:00
},
"user_type": {
"type": "string",
"example": "user"
},
"username": {
"type": "string",
"example": "admin"
2025-07-02 16:17:59 +08:00
}
}
},
2025-07-13 16:36:20 +08:00
"responses.UserSecretsResponse": {
2025-07-02 16:17:59 +08:00
"type": "object",
"properties": {
2025-07-13 16:36:20 +08:00
"access_id": {
"type": "string"
},
"access_key": {
"type": "string"
},
"created_at": {
"type": "string"
},
2025-07-02 16:17:59 +08:00
"expires_at": {
2025-07-13 16:36:20 +08:00
"type": "string"
2025-07-02 16:17:59 +08:00
},
2025-07-13 16:36:20 +08:00
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"last_used_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "string"
2025-07-02 16:17:59 +08:00
}
}
},
2025-07-13 16:36:20 +08:00
"responses.WalletResponse": {
2025-07-02 16:17:59 +08:00
"type": "object",
"properties": {
2025-07-13 16:36:20 +08:00
"balance": {
"type": "number"
},
2025-07-02 16:17:59 +08:00
"created_at": {
2025-07-13 16:36:20 +08:00
"type": "string"
2025-07-02 16:17:59 +08:00
},
"id": {
2025-07-13 16:36:20 +08:00
"type": "string"
2025-07-02 16:17:59 +08:00
},
2025-07-13 16:36:20 +08:00
"is_active": {
"type": "boolean"
2025-07-02 16:17:59 +08:00
},
"updated_at": {
2025-07-13 16:36:20 +08:00
"type": "string"
},
"user_id": {
"type": "string"
2025-07-02 16:17:59 +08:00
}
}
},
2025-07-13 16:36:20 +08:00
"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"
}
}
2025-07-02 16:17:59 +08:00
}
},
"securityDefinitions": {
"Bearer": {
"description": "Type \"Bearer\" followed by a space and JWT token.",
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}