team/tyapi-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
e05ad9e2232fcbcdaa282658fa2920e3043bc1a6
tyapi-server/docs/docs.go
liangzai 5d5372e359 add article
2025-09-01 18:29:59 +08:00

9258 lines
313 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

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

// Package docs Code generated by swaggo/swag. DO NOT EDIT
package docs
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/:api_name": {
"post": {
"description": "统一API调用入口，参数加密传输",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"API调用"
],
"summary": "API调用",
"parameters": [
{
"description": "API调用请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.ApiCallCommand"
}
}
],
"responses": {
"200": {
"description": "调用成功",
"schema": {
"$ref": "#/definitions/dto.ApiCallResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"$ref": "#/definitions/dto.ApiCallResponse"
}
},
"401": {
"description": "未授权",
"schema": {
"$ref": "#/definitions/dto.ApiCallResponse"
}
},
"429": {
"description": "请求过于频繁",
"schema": {
"$ref": "#/definitions/dto.ApiCallResponse"
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"$ref": "#/definitions/dto.ApiCallResponse"
}
}
}
}
},
"/api/v1/admin/api-calls": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "管理员获取API调用记录，支持筛选和分页",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"API管理"
],
"summary": "获取管理端API调用记录",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "每页数量",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"description": "用户ID",
"name": "user_id",
"in": "query"
},
{
"type": "string",
"description": "交易ID",
"name": "transaction_id",
"in": "query"
},
{
"type": "string",
"description": "产品名称",
"name": "product_name",
"in": "query"
},
{
"type": "string",
"description": "状态",
"name": "status",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "开始时间",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "结束时间",
"name": "end_time",
"in": "query"
},
{
"type": "string",
"description": "排序字段",
"name": "sort_by",
"in": "query"
},
{
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "排序方向",
"name": "sort_order",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取API调用记录成功",
"schema": {
"$ref": "#/definitions/dto.ApiCallListResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/admin/invoices/pending": {
"get": {
"description": "管理员获取发票申请列表，支持状态和时间范围筛选",
"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": "状态筛选：pending/completed/rejected",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "开始时间 (格式: 2006-01-02 15:04:05)",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"description": "结束时间 (格式: 2006-01-02 15:04:05)",
"name": "end_time",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/interfaces.APIResponse"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/dto.PendingApplicationsResponse"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/api/v1/admin/invoices/{application_id}/approve": {
"post": {
"description": "管理员通过发票申请并上传发票文件",
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json"
],
"tags": [
"管理员-发票管理"
],
"summary": "通过发票申请",
"parameters": [
{
"type": "string",
"description": "申请ID",
"name": "application_id",
"in": "path",
"required": true
},
{
"type": "file",
"description": "发票文件",
"name": "file",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "管理员备注",
"name": "admin_notes",
"in": "formData"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/api/v1/admin/invoices/{application_id}/download": {
"get": {
"description": "管理员下载指定发票的文件",
"produces": [
"application/octet-stream"
],
"tags": [
"管理员-发票管理"
],
"summary": "管理员下载发票文件",
"parameters": [
{
"type": "string",
"description": "申请ID",
"name": "application_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/api/v1/admin/invoices/{application_id}/reject": {
"post": {
"description": "管理员拒绝发票申请",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"管理员-发票管理"
],
"summary": "拒绝发票申请",
"parameters": [
{
"type": "string",
"description": "申请ID",
"name": "application_id",
"in": "path",
"required": true
},
{
"description": "拒绝申请请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/finance.RejectInvoiceRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/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/tyapi-server_internal_application_product_dto_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": "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.ProductAdminListResponse"
}
},
"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/available": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "管理员获取可选作组合包子产品的产品列表",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"产品管理"
],
"summary": "获取可选子产品列表",
"parameters": [
{
"type": "string",
"description": "排除的组合包ID",
"name": "exclude_package_id",
"in": "query"
},
{
"type": "string",
"description": "搜索关键词",
"name": "keyword",
"in": "query"
},
{
"type": "string",
"description": "分类ID",
"name": "category_id",
"in": "query"
},
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 20,
"description": "每页数量",
"name": "page_size",
"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
}
}
}
}
},
"/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
},
{
"type": "boolean",
"description": "是否包含文档信息",
"name": "with_document",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取产品详情成功",
"schema": {
"$ref": "#/definitions/responses.ProductAdminInfoResponse"
}
},
"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/products/{id}/api-config": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "管理员获取产品的API配置信息，如果不存在则返回空配置",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"产品管理"
],
"summary": "获取产品API配置",
"parameters": [
{
"type": "string",
"description": "产品ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "获取API配置成功",
"schema": {
"$ref": "#/definitions/responses.ProductApiConfigResponse"
}
},
"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": "管理员更新产品的API配置",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"产品管理"
],
"summary": "更新产品API配置",
"parameters": [
{
"type": "string",
"description": "产品ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "API配置信息",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/responses.ProductApiConfigResponse"
}
}
],
"responses": {
"200": {
"description": "API配置更新成功",
"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
}
}
}
},
"post": {
"security": [
{
"Bearer": []
}
],
"description": "管理员为产品创建API配置",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"产品管理"
],
"summary": "创建产品API配置",
"parameters": [
{
"type": "string",
"description": "产品ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "API配置信息",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/responses.ProductApiConfigResponse"
}
}
],
"responses": {
"201": {
"description": "API配置创建成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"409": {
"description": "API配置已存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "管理员删除产品的API配置",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"产品管理"
],
"summary": "删除产品API配置",
"parameters": [
{
"type": "string",
"description": "产品ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "API配置删除成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "产品或API配置不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/admin/products/{id}/documentation": {
"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.DocumentationResponse"
}
},
"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
}
}
}
},
"post": {
"security": [
{
"Bearer": []
}
],
"description": "管理员创建或更新产品的文档信息，如果文档不存在则创建，存在则更新",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"产品管理"
],
"summary": "创建或更新产品文档",
"parameters": [
{
"type": "string",
"description": "产品ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "文档信息",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.CreateDocumentationCommand"
}
}
],
"responses": {
"200": {
"description": "文档操作成功",
"schema": {
"$ref": "#/definitions/responses.DocumentationResponse"
}
},
"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/{id}/package-items": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "管理员向组合包添加子产品",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"产品管理"
],
"summary": "添加组合包子产品",
"parameters": [
{
"type": "string",
"description": "组合包ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "添加子产品命令",
"name": "command",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.AddPackageItemCommand"
}
}
],
"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/{id}/package-items/batch": {
"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": "command",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.UpdatePackageItemsCommand"
}
}
],
"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/{id}/package-items/reorder": {
"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": "command",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.ReorderPackageItemsCommand"
}
}
],
"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/{id}/package-items/{item_id}": {
"put": {
"security": [
{
"Bearer": []
}
],
"description": "管理员更新组合包子产品信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"产品管理"
],
"summary": "更新组合包子产品",
"parameters": [
{
"type": "string",
"description": "组合包ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "string",
"description": "子产品项目ID",
"name": "item_id",
"in": "path",
"required": true
},
{
"description": "更新子产品命令",
"name": "command",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.UpdatePackageItemCommand"
}
}
],
"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
},
{
"type": "string",
"description": "子产品项目ID",
"name": "item_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/recharge-records": {
"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": "用户ID",
"name": "user_id",
"in": "query"
},
{
"enum": [
"alipay",
"transfer",
"gift"
],
"type": "string",
"description": "充值类型",
"name": "recharge_type",
"in": "query"
},
{
"enum": [
"pending",
"success",
"failed"
],
"type": "string",
"description": "状态",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "最小金额",
"name": "min_amount",
"in": "query"
},
{
"type": "string",
"description": "最大金额",
"name": "max_amount",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "开始时间",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "结束时间",
"name": "end_time",
"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.RechargeRecordListResponse"
}
},
"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": {
"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": "企业名称",
"name": "company_name",
"in": "query"
},
{
"type": "string",
"description": "产品名称",
"name": "product_name",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "订阅开始时间",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "订阅结束时间",
"name": "end_time",
"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/admin/subscriptions/batch-update-prices": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "管理员一键调整用户所有订阅的价格",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"订阅管理"
],
"summary": "一键改价",
"parameters": [
{
"description": "批量改价请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.BatchUpdateSubscriptionPricesCommand"
}
}
],
"responses": {
"200": {
"description": "一键改价成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/admin/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/admin/wallet-transactions": {
"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": "用户ID",
"name": "user_id",
"in": "query"
},
{
"type": "string",
"description": "交易ID",
"name": "transaction_id",
"in": "query"
},
{
"type": "string",
"description": "产品名称",
"name": "product_name",
"in": "query"
},
{
"type": "string",
"description": "最小金额",
"name": "min_amount",
"in": "query"
},
{
"type": "string",
"description": "最大金额",
"name": "max_amount",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "开始时间",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "结束时间",
"name": "end_time",
"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.WalletTransactionListResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/articles": {
"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": "分类ID",
"name": "category_id",
"in": "query"
},
{
"type": "string",
"description": "作者ID",
"name": "author_id",
"in": "query"
},
{
"type": "boolean",
"description": "是否推荐",
"name": "is_featured",
"in": "query"
},
{
"type": "string",
"description": "排序字段",
"name": "order_by",
"in": "query"
},
{
"type": "string",
"description": "排序方向",
"name": "order_dir",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取文章列表成功",
"schema": {
"$ref": "#/definitions/responses.ArticleListResponse"
}
},
"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.CreateArticleCommand"
}
}
],
"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/articles/search": {
"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",
"required": true
},
{
"type": "string",
"description": "分类ID",
"name": "category_id",
"in": "query"
},
{
"type": "string",
"description": "作者ID",
"name": "author_id",
"in": "query"
},
{
"type": "string",
"description": "文章状态",
"name": "status",
"in": "query"
},
{
"type": "string",
"description": "排序字段",
"name": "order_by",
"in": "query"
},
{
"type": "string",
"description": "排序方向",
"name": "order_dir",
"in": "query"
}
],
"responses": {
"200": {
"description": "搜索文章成功",
"schema": {
"$ref": "#/definitions/responses.ArticleListResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/articles/stats": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取文章相关统计数据",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"文章管理"
],
"summary": "获取文章统计",
"responses": {
"200": {
"description": "获取统计成功",
"schema": {
"$ref": "#/definitions/responses.ArticleStatsResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/articles/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "根据ID获取文章详情",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"文章管理"
],
"summary": "获取文章详情",
"parameters": [
{
"type": "string",
"description": "文章ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "获取文章详情成功",
"schema": {
"$ref": "#/definitions/responses.ArticleInfoResponse"
}
},
"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.UpdateArticleCommand"
}
}
],
"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/articles/{id}/archive": {
"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/articles/{id}/featured": {
"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.SetFeaturedCommand"
}
}
],
"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/articles/{id}/publish": {
"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/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/tyapi-server_internal_application_product_dto_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/confirm-auth": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "前端轮询确认企业认证是否完成",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"认证管理"
],
"summary": "前端确认认证状态",
"parameters": [
{
"description": "确认状态请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/queries.ConfirmAuthCommand"
}
}
],
"responses": {
"200": {
"description": "状态确认成功",
"schema": {
"$ref": "#/definitions/responses.ConfirmAuthResponse"
}
},
"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/confirm-sign": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "前端轮询确认合同签署是否完成",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"认证管理"
],
"summary": "前端确认签署状态",
"parameters": [
{
"description": "确认状态请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/queries.ConfirmSignCommand"
}
}
],
"responses": {
"200": {
"description": "状态确认成功",
"schema": {
"$ref": "#/definitions/responses.ConfirmSignResponse"
}
},
"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/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/certifications/esign/callback": {
"post": {
"description": "处理e签宝的异步回调通知",
"consumes": [
"application/json"
],
"produces": [
"text/plain"
],
"tags": [
"认证管理"
],
"summary": "处理e签宝回调",
"responses": {
"200": {
"description": "success",
"schema": {
"type": "string"
}
},
"400": {
"description": "fail",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/debug/event-system": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "调试事件系统，用于测试事件触发和处理",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"系统调试"
],
"summary": "调试事件系统",
"responses": {
"200": {
"description": "调试成功",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/decrypt": {
"post": {
"security": [
{
"Bearer": []
}
],
"description": "使用密钥解密加密的数据",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"API调试"
],
"summary": "解密参数",
"parameters": [
{
"description": "解密请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.DecryptCommand"
}
}
],
"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/encrypt": {
"post": {
"description": "用于前端调试时加密API调用参数",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"API调试"
],
"summary": "加密参数",
"parameters": [
{
"description": "加密请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/commands.EncryptCommand"
}
}
],
"responses": {
"200": {
"description": "加密成功",
"schema": {
"$ref": "#/definitions/dto.EncryptResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"$ref": "#/definitions/dto.EncryptResponse"
}
},
"401": {
"description": "未授权",
"schema": {
"$ref": "#/definitions/dto.EncryptResponse"
}
}
}
}
},
"/api/v1/finance/alipay/callback": {
"post": {
"description": "处理支付宝异步支付通知",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"text/plain"
],
"tags": [
"支付管理"
],
"summary": "支付宝支付回调",
"responses": {
"200": {
"description": "success",
"schema": {
"type": "string"
}
},
"400": {
"description": "fail",
"schema": {
"type": "string"
}
}
}
}
},
"/api/v1/finance/alipay/return": {
"get": {
"description": "处理支付宝同步支付通知，跳转到前端成功页面",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"text/html"
],
"tags": [
"支付管理"
],
"summary": "支付宝同步回调",
"responses": {
"200": {
"description": "支付成功页面",
"schema": {
"type": "string"
}
},
"400": {
"description": "支付失败页面",
"schema": {
"type": "string"
}
}
}
}
},
"/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
}
}
}
}
},
"/api/v1/finance/wallet/alipay-order-status": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取支付宝订单的当前状态，用于轮询查询",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"钱包管理"
],
"summary": "获取支付宝订单状态",
"parameters": [
{
"type": "string",
"description": "商户订单号",
"name": "out_trade_no",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "获取订单状态成功",
"schema": {
"$ref": "#/definitions/responses.AlipayOrderStatusResponse"
}
},
"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/wallet/alipay-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.CreateAlipayRechargeCommand"
}
}
],
"responses": {
"200": {
"description": "创建充值订单成功",
"schema": {
"$ref": "#/definitions/responses.AlipayRechargeOrderResponse"
}
},
"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/recharge-config": {
"get": {
"description": "获取当前环境的充值配置信息（最低充值金额、最高充值金额等）",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"钱包管理"
],
"summary": "获取充值配置",
"responses": {
"200": {
"description": "获取充值配置成功",
"schema": {
"$ref": "#/definitions/responses.RechargeConfigResponse"
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/finance/wallet/transactions": {
"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": "开始时间 (格式: 2006-01-02 15:04:05)",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"description": "结束时间 (格式: 2006-01-02 15:04:05)",
"name": "end_time",
"in": "query"
},
{
"type": "string",
"description": "交易ID",
"name": "transaction_id",
"in": "query"
},
{
"type": "string",
"description": "产品名称",
"name": "product_name",
"in": "query"
},
{
"type": "string",
"description": "最小金额",
"name": "min_amount",
"in": "query"
},
{
"type": "string",
"description": "最大金额",
"name": "max_amount",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"$ref": "#/definitions/responses.WalletTransactionListResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/form-config/{api_code}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取指定API的表单配置，用于前端动态生成表单",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"API调试"
],
"summary": "获取表单配置",
"parameters": [
{
"type": "string",
"description": "API代码",
"name": "api_code",
"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": "API接口不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/invoices/apply": {
"post": {
"description": "用户申请开票",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"发票管理"
],
"summary": "申请开票",
"parameters": [
{
"description": "申请开票请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/finance.ApplyInvoiceRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/interfaces.APIResponse"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/dto.InvoiceApplicationResponse"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/api/v1/invoices/available-amount": {
"get": {
"description": "获取用户当前可开票的金额",
"produces": [
"application/json"
],
"tags": [
"发票管理"
],
"summary": "获取可开票金额",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/interfaces.APIResponse"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/dto.AvailableAmountResponse"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/api/v1/invoices/info": {
"get": {
"description": "获取用户的发票信息",
"produces": [
"application/json"
],
"tags": [
"发票管理"
],
"summary": "获取用户发票信息",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/interfaces.APIResponse"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/dto.InvoiceInfoResponse"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
},
"put": {
"description": "更新用户的发票信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"发票管理"
],
"summary": "更新用户发票信息",
"parameters": [
{
"description": "更新发票信息请求",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/finance.UpdateInvoiceInfoRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/api/v1/invoices/records": {
"get": {
"description": "获取用户的开票记录列表",
"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": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/interfaces.APIResponse"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/dto.InvoiceRecordsResponse"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/api/v1/invoices/{application_id}/download": {
"get": {
"description": "下载指定发票的文件",
"produces": [
"application/octet-stream"
],
"tags": [
"发票管理"
],
"summary": "下载发票文件",
"parameters": [
{
"type": "string",
"description": "申请ID",
"name": "application_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "file"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/api/v1/my/api-calls": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "获取当前用户的API调用记录列表，支持分页和筛选",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"API管理"
],
"summary": "获取用户API调用记录",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "页码",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 10,
"description": "每页数量",
"name": "page_size",
"in": "query"
},
{
"type": "string",
"description": "开始时间 (格式: 2006-01-02 15:04:05)",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"description": "结束时间 (格式: 2006-01-02 15:04:05)",
"name": "end_time",
"in": "query"
},
{
"type": "string",
"description": "交易ID",
"name": "transaction_id",
"in": "query"
},
{
"type": "string",
"description": "产品名称",
"name": "product_name",
"in": "query"
},
{
"type": "string",
"description": "状态 (pending/success/failed)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"$ref": "#/definitions/dto.ApiCallListResponse"
}
},
"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": "keyword",
"in": "query"
},
{
"type": "string",
"description": "产品名称",
"name": "product_name",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "订阅开始时间",
"name": "start_time",
"in": "query"
},
{
"type": "string",
"format": "date-time",
"description": "订阅结束时间",
"name": "end_time",
"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": {
"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/my/whitelist/{ip}": {
"delete": {
"security": [
{
"Bearer": []
}
],
"description": "从当前用户的白名单中删除指定IP地址",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"API管理"
],
"summary": "删除白名单IP",
"parameters": [
{
"type": "string",
"description": "IP地址",
"name": "ip",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "删除白名单IP成功",
"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/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": "boolean",
"description": "是否启用",
"name": "is_enabled",
"in": "query"
},
{
"type": "boolean",
"description": "是否可见",
"name": "is_visible",
"in": "query"
},
{
"type": "boolean",
"description": "是否组合包",
"name": "is_package",
"in": "query"
},
{
"type": "boolean",
"description": "是否已订阅（需要认证）",
"name": "is_subscribed",
"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/code/{product_code}/api-config": {
"get": {
"description": "根据产品代码获取API配置信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"产品API配置"
],
"summary": "根据产品代码获取API配置",
"parameters": [
{
"type": "string",
"description": "产品代码",
"name": "product_code",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"$ref": "#/definitions/responses.ProductApiConfigResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"404": {
"description": "配置不存在",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/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": "获取产品详细信息，用户端只能查看可见的产品",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"数据大厅"
],
"summary": "获取产品详情",
"parameters": [
{
"type": "string",
"description": "产品ID",
"name": "id",
"in": "path",
"required": true
},
{
"type": "boolean",
"description": "是否包含文档信息",
"name": "with_document",
"in": "query"
}
],
"responses": {
"200": {
"description": "获取产品详情成功",
"schema": {
"$ref": "#/definitions/responses.ProductInfoWithDocumentResponse"
}
},
"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}/api-config": {
"get": {
"description": "根据产品ID获取API配置信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"产品API配置"
],
"summary": "获取产品API配置",
"parameters": [
{
"type": "string",
"description": "产品ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "获取成功",
"schema": {
"$ref": "#/definitions/responses.ProductApiConfigResponse"
}
},
"400": {
"description": "请求参数错误",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
},
"404": {
"description": "配置不存在",
"schema": {
"$ref": "#/definitions/interfaces.APIResponse"
}
}
}
}
},
"/api/v1/products/{id}/documentation": {
"get": {
"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.DocumentationResponse"
}
},
"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/admin/list": {
"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": "phone",
"in": "query"
},
{
"enum": [
"user",
"admin"
],
"type": "string",
"description": "用户类型筛选",
"name": "user_type",
"in": "query"
},
{
"type": "boolean",
"description": "是否激活筛选",
"name": "is_active",
"in": "query"
},
{
"type": "boolean",
"description": "是否已认证筛选",
"name": "is_certified",
"in": "query"
},
{
"type": "string",
"description": "企业名称筛选",
"name": "company_name",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "开始日期",
"name": "start_date",
"in": "query"
},
{
"type": "string",
"format": "date",
"description": "结束日期",
"name": "end_date",
"in": "query"
}
],
"responses": {
"200": {
"description": "用户列表",
"schema": {
"$ref": "#/definitions/responses.UserListResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"403": {
"description": "权限不足",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/users/admin/stats": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "管理员获取用户相关的统计信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户管理"
],
"summary": "获取用户统计信息",
"responses": {
"200": {
"description": "用户统计信息",
"schema": {
"$ref": "#/definitions/responses.UserStatsResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"403": {
"description": "权限不足",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/users/admin/{user_id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"description": "管理员获取指定用户的详细信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户管理"
],
"summary": "管理员获取用户详情",
"parameters": [
{
"type": "string",
"description": "用户ID",
"name": "user_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "用户详情",
"schema": {
"$ref": "#/definitions/responses.UserDetailResponse"
}
},
"401": {
"description": "未认证",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"403": {
"description": "权限不足",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"404": {
"description": "用户不存在",
"schema": {
"type": "object",
"additionalProperties": true
}
},
"500": {
"description": "服务器内部错误",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/api/v1/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.AddPackageItemCommand": {
"type": "object",
"required": [
"product_id"
],
"properties": {
"product_id": {
"type": "string"
}
}
},
"commands.ApiCallCommand": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "string"
},
"options": {
"$ref": "#/definitions/commands.ApiCallOptions"
}
}
},
"commands.ApiCallOptions": {
"type": "object",
"properties": {
"is_debug": {
"description": "是否为调试调用",
"type": "boolean"
},
"json": {
"description": "是否返回JSON格式",
"type": "boolean"
}
}
},
"commands.ApplyContractCommand": {
"type": "object",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "string"
}
}
},
"commands.BatchUpdateSubscriptionPricesCommand": {
"type": "object",
"required": [
"discount",
"scope",
"user_id"
],
"properties": {
"discount": {
"type": "number",
"maximum": 10,
"minimum": 0.1
},
"scope": {
"type": "string",
"enum": [
"undiscounted",
"all"
]
},
"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.CreateAlipayRechargeCommand": {
"type": "object",
"required": [
"amount",
"platform"
],
"properties": {
"amount": {
"description": "充值金额",
"type": "string"
},
"platform": {
"description": "支付平台：app/h5/pc",
"type": "string",
"enum": [
"app",
"h5",
"pc"
]
}
}
},
"commands.CreateArticleCommand": {
"type": "object",
"required": [
"content",
"title"
],
"properties": {
"category_id": {
"type": "string"
},
"content": {
"type": "string"
},
"cover_image": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"summary": {
"type": "string"
},
"tag_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"type": "string"
}
}
},
"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.CreateDocumentationCommand": {
"type": "object",
"required": [
"basic_info",
"product_id",
"request_method",
"request_params",
"request_url"
],
"properties": {
"basic_info": {
"type": "string"
},
"error_codes": {
"type": "string"
},
"product_id": {
"type": "string"
},
"request_method": {
"type": "string"
},
"request_params": {
"type": "string"
},
"request_url": {
"type": "string"
},
"response_example": {
"type": "string"
},
"response_fields": {
"type": "string"
}
}
},
"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.DecryptCommand": {
"type": "object",
"required": [
"encrypted_data",
"secret_key"
],
"properties": {
"encrypted_data": {
"type": "string"
},
"secret_key": {
"type": "string"
}
}
},
"commands.EncryptCommand": {
"type": "object",
"required": [
"data",
"secret_key"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"secret_key": {
"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.PackageItemData": {
"type": "object",
"required": [
"product_id",
"sort_order"
],
"properties": {
"product_id": {
"type": "string"
},
"sort_order": {
"type": "integer",
"minimum": 0
}
}
},
"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.ReorderPackageItemsCommand": {
"type": "object",
"required": [
"item_ids"
],
"properties": {
"item_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"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.SetFeaturedCommand": {
"type": "object",
"required": [
"is_featured"
],
"properties": {
"is_featured": {
"type": "boolean"
}
}
},
"commands.SubmitEnterpriseInfoCommand": {
"type": "object",
"required": [
"company_name",
"enterprise_address",
"legal_person_id",
"legal_person_name",
"legal_person_phone",
"unified_social_code",
"verification_code"
],
"properties": {
"company_name": {
"type": "string",
"maxLength": 100,
"minLength": 2
},
"enterprise_address": {
"type": "string"
},
"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.UpdateArticleCommand": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
},
"content": {
"type": "string"
},
"cover_image": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"summary": {
"type": "string"
},
"tag_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"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.UpdatePackageItemCommand": {
"type": "object",
"required": [
"sort_order"
],
"properties": {
"sort_order": {
"type": "integer",
"minimum": 0
}
}
},
"commands.UpdatePackageItemsCommand": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/commands.PackageItemData"
}
}
}
},
"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
}
}
},
"dto.ApiCallListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/dto.ApiCallRecordResponse"
}
},
"page": {
"type": "integer"
},
"size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"dto.ApiCallRecordResponse": {
"type": "object",
"properties": {
"access_id": {
"type": "string"
},
"client_ip": {
"type": "string"
},
"company_name": {
"type": "string"
},
"cost": {
"type": "string"
},
"created_at": {
"type": "string"
},
"end_at": {
"type": "string"
},
"error_msg": {
"type": "string"
},
"error_type": {
"type": "string"
},
"id": {
"type": "string"
},
"product_id": {
"type": "string"
},
"product_name": {
"type": "string"
},
"start_at": {
"type": "string"
},
"status": {
"type": "string"
},
"transaction_id": {
"type": "string"
},
"translated_error_msg": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user": {
"$ref": "#/definitions/dto.UserSimpleResponse"
},
"user_id": {
"type": "string"
}
}
},
"dto.ApiCallResponse": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"data": {
"type": "string"
},
"message": {
"type": "string"
},
"transaction_id": {
"type": "string"
}
}
},
"dto.AvailableAmountResponse": {
"type": "object",
"properties": {
"available_amount": {
"description": "可开票金额",
"type": "number"
},
"pending_applications": {
"description": "待处理申请金额",
"type": "number"
},
"total_gifted": {
"description": "总赠送金额",
"type": "number"
},
"total_invoiced": {
"description": "已开票金额",
"type": "number"
},
"total_recharged": {
"description": "总充值金额",
"type": "number"
}
}
},
"dto.EncryptResponse": {
"type": "object",
"properties": {
"encrypted_data": {
"type": "string"
}
}
},
"dto.InvoiceApplicationResponse": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"invoice_info": {
"$ref": "#/definitions/value_objects.InvoiceInfo"
},
"invoice_type": {
"$ref": "#/definitions/value_objects.InvoiceType"
},
"status": {
"$ref": "#/definitions/entities.ApplicationStatus"
},
"user_id": {
"type": "string"
}
}
},
"dto.InvoiceInfoResponse": {
"type": "object",
"properties": {
"bank_account": {
"description": "用户可编辑",
"type": "string"
},
"bank_name": {
"description": "用户可编辑",
"type": "string"
},
"company_address": {
"description": "用户可编辑",
"type": "string"
},
"company_name": {
"description": "从企业认证信息获取，只读",
"type": "string"
},
"company_name_read_only": {
"description": "字段权限标识",
"type": "boolean"
},
"company_phone": {
"description": "用户可编辑",
"type": "string"
},
"is_complete": {
"type": "boolean"
},
"missing_fields": {
"type": "array",
"items": {
"type": "string"
}
},
"receiving_email": {
"description": "用户可编辑",
"type": "string"
},
"taxpayer_id": {
"description": "从企业认证信息获取，只读",
"type": "string"
},
"taxpayer_id_read_only": {
"description": "纳税人识别号是否只读",
"type": "boolean"
}
}
},
"dto.InvoiceRecordResponse": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"bank_account": {
"description": "银行账号",
"type": "string"
},
"bank_name": {
"description": "开户银行",
"type": "string"
},
"company_address": {
"description": "企业地址",
"type": "string"
},
"company_name": {
"description": "开票信息（快照数据）",
"type": "string"
},
"company_phone": {
"description": "企业电话",
"type": "string"
},
"created_at": {
"type": "string"
},
"file_name": {
"description": "文件信息",
"type": "string"
},
"file_size": {
"type": "integer"
},
"file_url": {
"type": "string"
},
"id": {
"type": "string"
},
"invoice_type": {
"$ref": "#/definitions/value_objects.InvoiceType"
},
"processed_at": {
"description": "时间信息",
"type": "string"
},
"receiving_email": {
"description": "接收邮箱",
"type": "string"
},
"reject_reason": {
"description": "拒绝原因",
"type": "string"
},
"status": {
"$ref": "#/definitions/entities.ApplicationStatus"
},
"taxpayer_id": {
"description": "纳税人识别号",
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"dto.InvoiceRecordsResponse": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"records": {
"type": "array",
"items": {
"$ref": "#/definitions/dto.InvoiceRecordResponse"
}
},
"total": {
"type": "integer"
},
"total_pages": {
"type": "integer"
}
}
},
"dto.PendingApplicationResponse": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"bank_account": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"company_address": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_phone": {
"type": "string"
},
"created_at": {
"type": "string"
},
"file_name": {
"type": "string"
},
"file_size": {
"type": "integer"
},
"file_url": {
"type": "string"
},
"id": {
"type": "string"
},
"invoice_type": {
"$ref": "#/definitions/value_objects.InvoiceType"
},
"processed_at": {
"type": "string"
},
"receiving_email": {
"type": "string"
},
"reject_reason": {
"type": "string"
},
"status": {
"$ref": "#/definitions/entities.ApplicationStatus"
},
"taxpayer_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"dto.PendingApplicationsResponse": {
"type": "object",
"properties": {
"applications": {
"type": "array",
"items": {
"$ref": "#/definitions/dto.PendingApplicationResponse"
}
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
},
"total_pages": {
"type": "integer"
}
}
},
"dto.UserSimpleResponse": {
"type": "object",
"properties": {
"company_name": {
"type": "string"
},
"id": {
"type": "string"
},
"phone": {
"type": "string"
}
}
},
"entities.ApplicationStatus": {
"type": "string",
"enum": [
"pending",
"completed",
"rejected"
],
"x-enum-comments": {
"ApplicationStatusCompleted": "已完成（已上传发票）",
"ApplicationStatusPending": "待处理",
"ApplicationStatusRejected": "已拒绝"
},
"x-enum-descriptions": [
"待处理",
"已完成（已上传发票）",
"已拒绝"
],
"x-enum-varnames": [
"ApplicationStatusPending",
"ApplicationStatusCompleted",
"ApplicationStatusRejected"
]
},
"enums.CertificationStatus": {
"type": "string",
"enum": [
"pending",
"info_submitted",
"enterprise_verified",
"contract_applied",
"contract_signed",
"completed",
"info_rejected",
"contract_rejected",
"contract_expired"
],
"x-enum-comments": {
"StatusCompleted": "认证完成",
"StatusContractApplied": "已申请签署合同",
"StatusContractExpired": "合同签署超时",
"StatusContractRejected": "合同被拒签",
"StatusContractSigned": "已签署合同",
"StatusEnterpriseVerified": "已企业认证",
"StatusInfoRejected": "企业信息被拒绝",
"StatusInfoSubmitted": "已提交企业信息",
"StatusPending": "待认证"
},
"x-enum-descriptions": [
"待认证",
"已提交企业信息",
"已企业认证",
"已申请签署合同",
"已签署合同",
"认证完成",
"企业信息被拒绝",
"合同被拒签",
"合同签署超时"
],
"x-enum-varnames": [
"StatusPending",
"StatusInfoSubmitted",
"StatusEnterpriseVerified",
"StatusContractApplied",
"StatusContractSigned",
"StatusCompleted",
"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-descriptions": [
"企业不存在",
"企业信息不匹配",
"企业状态异常",
"法定代表人信息不匹配",
"e签宝验证失败",
"证件信息无效",
"用户拒绝签署",
"合同签署超时",
"签署流程失败",
"合同生成失败",
"e签宝流程错误",
"系统错误",
"网络错误",
"操作超时",
"未知错误"
],
"x-enum-varnames": [
"FailureReasonEnterpriseNotExists",
"FailureReasonEnterpriseInfoMismatch",
"FailureReasonEnterpriseStatusAbnormal",
"FailureReasonLegalPersonMismatch",
"FailureReasonEsignVerificationFailed",
"FailureReasonInvalidDocument",
"FailureReasonContractRejectedByUser",
"FailureReasonContractExpired",
"FailureReasonSignProcessFailed",
"FailureReasonContractGenFailed",
"FailureReasonEsignFlowError",
"FailureReasonSystemError",
"FailureReasonNetworkError",
"FailureReasonTimeout",
"FailureReasonUnknownError"
]
},
"finance.ApplyInvoiceRequest": {
"type": "object",
"required": [
"amount",
"invoice_type"
],
"properties": {
"amount": {
"description": "开票金额",
"type": "string"
},
"invoice_type": {
"description": "发票类型：general/special",
"type": "string"
}
}
},
"finance.RejectInvoiceRequest": {
"type": "object",
"required": [
"reason"
],
"properties": {
"reason": {
"description": "拒绝原因",
"type": "string"
}
}
},
"finance.UpdateInvoiceInfoRequest": {
"type": "object",
"required": [
"receiving_email"
],
"properties": {
"bank_account": {
"description": "银行账户",
"type": "string"
},
"bank_name": {
"description": "银行名称",
"type": "string"
},
"company_address": {
"description": "公司地址",
"type": "string"
},
"company_name": {
"description": "公司名称（从企业认证信息获取，用户不可修改）",
"type": "string"
},
"company_phone": {
"description": "企业注册电话",
"type": "string"
},
"receiving_email": {
"description": "发票接收邮箱",
"type": "string"
},
"taxpayer_id": {
"description": "纳税人识别号（从企业认证信息获取，用户不可修改）",
"type": "string"
}
}
},
"interfaces.APIResponse": {
"type": "object",
"properties": {
"data": {},
"errors": {},
"message": {
"type": "string"
},
"meta": {
"type": "object",
"additionalProperties": true
},
"pagination": {
"$ref": "#/definitions/interfaces.PaginationMeta"
},
"request_id": {
"type": "string"
},
"success": {
"type": "boolean"
},
"timestamp": {
"type": "integer"
}
}
},
"interfaces.PaginationMeta": {
"type": "object",
"properties": {
"has_next": {
"type": "boolean"
},
"has_prev": {
"type": "boolean"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"total": {
"type": "integer"
},
"total_pages": {
"type": "integer"
}
}
},
"queries.ConfirmAuthCommand": {
"type": "object"
},
"queries.ConfirmSignCommand": {
"type": "object"
},
"responses.AlipayOrderStatusResponse": {
"type": "object",
"properties": {
"amount": {
"description": "订单金额",
"type": "number"
},
"can_retry": {
"description": "是否可以重试",
"type": "boolean"
},
"created_at": {
"description": "创建时间",
"type": "string"
},
"error_code": {
"description": "错误码",
"type": "string"
},
"error_message": {
"description": "错误信息",
"type": "string"
},
"is_processing": {
"description": "是否处理中",
"type": "boolean"
},
"notify_time": {
"description": "异步通知时间",
"type": "string"
},
"out_trade_no": {
"description": "商户订单号",
"type": "string"
},
"platform": {
"description": "支付平台",
"type": "string"
},
"return_time": {
"description": "同步返回时间",
"type": "string"
},
"status": {
"description": "订单状态",
"type": "string"
},
"subject": {
"description": "订单标题",
"type": "string"
},
"trade_no": {
"description": "支付宝交易号",
"type": "string"
},
"updated_at": {
"description": "更新时间",
"type": "string"
}
}
},
"responses.AlipayRechargeBonusRuleResponse": {
"type": "object",
"properties": {
"bonus_amount": {
"type": "number"
},
"recharge_amount": {
"type": "number"
}
}
},
"responses.AlipayRechargeOrderResponse": {
"type": "object",
"properties": {
"amount": {
"description": "充值金额",
"type": "number"
},
"out_trade_no": {
"description": "商户订单号",
"type": "string"
},
"pay_url": {
"description": "支付链接",
"type": "string"
},
"platform": {
"description": "支付平台",
"type": "string"
},
"subject": {
"description": "订单标题",
"type": "string"
}
}
},
"responses.ArticleInfoResponse": {
"type": "object",
"properties": {
"category": {
"$ref": "#/definitions/tyapi-server_internal_application_article_dto_responses.CategoryInfoResponse"
},
"category_id": {
"type": "string"
},
"content": {
"type": "string"
},
"cover_image": {
"type": "string"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"published_at": {
"type": "string"
},
"status": {
"type": "string"
},
"summary": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.TagInfoResponse"
}
},
"title": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"view_count": {
"type": "integer"
}
}
},
"responses.ArticleListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.ArticleInfoResponse"
}
},
"page": {
"type": "integer"
},
"size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"responses.ArticleStatsResponse": {
"type": "object",
"properties": {
"archived_articles": {
"type": "integer"
},
"draft_articles": {
"type": "integer"
},
"published_articles": {
"type": "integer"
},
"total_articles": {
"type": "integer"
},
"total_views": {
"type": "integer"
}
}
},
"responses.CategoryListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/tyapi-server_internal_application_product_dto_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"
},
"completed_at": {
"type": "string"
},
"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.ConfirmAuthResponse": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"status": {
"$ref": "#/definitions/enums.CertificationStatus"
}
}
},
"responses.ConfirmSignResponse": {
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"status": {
"$ref": "#/definitions/enums.CertificationStatus"
}
}
},
"responses.ContractInfoItem": {
"type": "object",
"properties": {
"contract_file_url": {
"type": "string"
},
"contract_name": {
"type": "string"
},
"contract_type": {
"description": "合同类型代码",
"type": "string"
},
"contract_type_name": {
"description": "合同类型中文名称",
"type": "string"
},
"created_at": {
"type": "string"
},
"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.DocumentationResponse": {
"type": "object",
"properties": {
"basic_info": {
"type": "string"
},
"created_at": {
"type": "string"
},
"error_codes": {
"type": "string"
},
"id": {
"type": "string"
},
"product_id": {
"type": "string"
},
"request_method": {
"type": "string"
},
"request_params": {
"type": "string"
},
"request_url": {
"type": "string"
},
"response_example": {
"type": "string"
},
"response_fields": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"responses.EnterpriseInfoItem": {
"type": "object",
"properties": {
"company_name": {
"type": "string"
},
"contracts": {
"description": "合同信息",
"type": "array",
"items": {
"$ref": "#/definitions/responses.ContractInfoItem"
}
},
"created_at": {
"type": "string"
},
"enterprise_address": {
"type": "string"
},
"id": {
"type": "string"
},
"legal_person_name": {
"type": "string"
},
"legal_person_phone": {
"type": "string"
},
"unified_social_code": {
"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"
},
"enterprise_address": {
"type": "string",
"example": "北京市朝阳区xxx街道xxx号"
},
"id": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"legal_person_id": {
"type": "string",
"example": "110101199001011234"
},
"legal_person_name": {
"type": "string",
"example": "张三"
},
"legal_person_phone": {
"type": "string",
"example": "13800138000"
},
"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.PackageItemResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"price": {
"type": "number"
},
"product_code": {
"type": "string"
},
"product_id": {
"type": "string"
},
"product_name": {
"type": "string"
},
"sort_order": {
"type": "integer"
}
}
},
"responses.ProductAdminInfoResponse": {
"type": "object",
"properties": {
"category": {
"description": "关联信息",
"allOf": [
{
"$ref": "#/definitions/tyapi-server_internal_application_product_dto_responses.CategoryInfoResponse"
}
]
},
"category_id": {
"type": "string"
},
"code": {
"type": "string"
},
"content": {
"type": "string"
},
"created_at": {
"type": "string"
},
"description": {
"type": "string"
},
"documentation": {
"description": "文档信息",
"allOf": [
{
"$ref": "#/definitions/responses.DocumentationResponse"
}
]
},
"id": {
"type": "string"
},
"is_enabled": {
"type": "boolean"
},
"is_package": {
"type": "boolean"
},
"is_visible": {
"type": "boolean"
},
"name": {
"type": "string"
},
"old_id": {
"type": "string"
},
"package_items": {
"description": "组合包信息",
"type": "array",
"items": {
"$ref": "#/definitions/responses.PackageItemResponse"
}
},
"price": {
"type": "number"
},
"seo_description": {
"type": "string"
},
"seo_keywords": {
"type": "string"
},
"seo_title": {
"description": "SEO信息",
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"responses.ProductAdminListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.ProductAdminInfoResponse"
}
},
"page": {
"type": "integer"
},
"size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"responses.ProductApiConfigResponse": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"product_id": {
"type": "string"
},
"request_params": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.RequestParamResponse"
}
},
"response_example": {
"type": "object",
"additionalProperties": true
},
"response_fields": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.ResponseFieldResponse"
}
},
"updated_at": {
"type": "string"
}
}
},
"responses.ProductInfoResponse": {
"type": "object",
"properties": {
"category": {
"description": "关联信息",
"allOf": [
{
"$ref": "#/definitions/tyapi-server_internal_application_product_dto_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_subscribed": {
"type": "boolean"
},
"name": {
"type": "string"
},
"old_id": {
"type": "string"
},
"package_items": {
"description": "组合包信息",
"type": "array",
"items": {
"$ref": "#/definitions/responses.PackageItemResponse"
}
},
"price": {
"type": "number"
},
"seo_description": {
"type": "string"
},
"seo_keywords": {
"type": "string"
},
"seo_title": {
"description": "SEO信息",
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"responses.ProductInfoWithDocumentResponse": {
"type": "object",
"properties": {
"category": {
"description": "关联信息",
"allOf": [
{
"$ref": "#/definitions/tyapi-server_internal_application_product_dto_responses.CategoryInfoResponse"
}
]
},
"category_id": {
"type": "string"
},
"code": {
"type": "string"
},
"content": {
"type": "string"
},
"created_at": {
"type": "string"
},
"description": {
"type": "string"
},
"documentation": {
"$ref": "#/definitions/responses.DocumentationResponse"
},
"id": {
"type": "string"
},
"is_enabled": {
"type": "boolean"
},
"is_package": {
"type": "boolean"
},
"is_subscribed": {
"type": "boolean"
},
"name": {
"type": "string"
},
"old_id": {
"type": "string"
},
"package_items": {
"description": "组合包信息",
"type": "array",
"items": {
"$ref": "#/definitions/responses.PackageItemResponse"
}
},
"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"
},
"is_subscribed": {
"type": "boolean"
},
"name": {
"type": "string"
},
"old_id": {
"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.RechargeConfigResponse": {
"type": "object",
"properties": {
"alipay_recharge_bonus": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.AlipayRechargeBonusRuleResponse"
}
},
"max_amount": {
"description": "最高充值金额",
"type": "string"
},
"min_amount": {
"description": "最低充值金额",
"type": "string"
}
}
},
"responses.RechargeRecordListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.RechargeRecordResponse"
}
},
"page": {
"type": "integer"
},
"size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"responses.RechargeRecordResponse": {
"type": "object",
"properties": {
"alipay_order_id": {
"type": "string"
},
"amount": {
"type": "number"
},
"company_name": {
"type": "string"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"notes": {
"type": "string"
},
"operator_id": {
"type": "string"
},
"recharge_type": {
"type": "string"
},
"status": {
"type": "string"
},
"transfer_order_id": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user": {
"$ref": "#/definitions/tyapi-server_internal_application_finance_dto_responses.UserSimpleResponse"
},
"user_id": {
"type": "string"
}
}
},
"responses.RegisterUserResponse": {
"description": "用户注册成功响应",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"phone": {
"type": "string",
"example": "13800138000"
}
}
},
"responses.RequestParamResponse": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"example": {
"type": "string"
},
"field": {
"type": "string"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"type": "string"
},
"validation": {
"type": "string"
}
}
},
"responses.ResponseFieldResponse": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"example": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"required": {
"type": "boolean"
},
"type": {
"type": "string"
}
}
},
"responses.SubscriptionInfoResponse": {
"type": "object",
"properties": {
"api_used": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"price": {
"type": "number"
},
"product": {
"$ref": "#/definitions/responses.ProductSimpleResponse"
},
"product_id": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user": {
"description": "关联信息",
"allOf": [
{
"$ref": "#/definitions/tyapi-server_internal_application_product_dto_responses.UserSimpleResponse"
}
]
},
"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.TagInfoResponse": {
"type": "object",
"properties": {
"color": {
"type": "string"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"responses.UserDetailResponse": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"enterprise_info": {
"description": "企业信息",
"allOf": [
{
"$ref": "#/definitions/responses.EnterpriseInfoItem"
}
]
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"is_certified": {
"type": "boolean"
},
"last_login_at": {
"type": "string"
},
"login_count": {
"type": "integer"
},
"phone": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_type": {
"type": "string"
},
"username": {
"type": "string"
},
"wallet_balance": {
"description": "钱包信息",
"type": "string"
}
}
},
"responses.UserListItem": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"enterprise_info": {
"description": "企业信息",
"allOf": [
{
"$ref": "#/definitions/responses.EnterpriseInfoItem"
}
]
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"is_certified": {
"type": "boolean"
},
"last_login_at": {
"type": "string"
},
"login_count": {
"type": "integer"
},
"phone": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_type": {
"type": "string"
},
"username": {
"type": "string"
},
"wallet_balance": {
"description": "钱包信息",
"type": "string"
}
}
},
"responses.UserListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.UserListItem"
}
},
"page": {
"type": "integer"
},
"size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"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.UserStatsResponse": {
"type": "object",
"properties": {
"active_users": {
"type": "integer"
},
"certified_users": {
"type": "integer"
},
"total_users": {
"type": "integer"
}
}
},
"responses.WalletResponse": {
"type": "object",
"properties": {
"balance": {
"type": "number"
},
"balance_status": {
"description": "normal, low, arrears",
"type": "string"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"is_arrears": {
"description": "是否欠费",
"type": "boolean"
},
"is_low_balance": {
"description": "是否余额较低",
"type": "boolean"
},
"updated_at": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"responses.WalletTransactionListResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/responses.WalletTransactionResponse"
}
},
"page": {
"type": "integer"
},
"size": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"responses.WalletTransactionResponse": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"api_call_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"created_at": {
"type": "string"
},
"id": {
"type": "string"
},
"product_id": {
"type": "string"
},
"product_name": {
"type": "string"
},
"transaction_id": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user": {
"$ref": "#/definitions/tyapi-server_internal_application_finance_dto_responses.UserSimpleResponse"
},
"user_id": {
"type": "string"
}
}
},
"tyapi-server_internal_application_article_dto_responses.CategoryInfoResponse": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"name": {
"type": "string"
},
"sort_order": {
"type": "integer"
}
}
},
"tyapi-server_internal_application_finance_dto_responses.UserSimpleResponse": {
"type": "object",
"properties": {
"company_name": {
"type": "string"
},
"id": {
"type": "string"
},
"phone": {
"type": "string"
}
}
},
"tyapi-server_internal_application_product_dto_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"
}
}
},
"tyapi-server_internal_application_product_dto_responses.UserSimpleResponse": {
"type": "object",
"properties": {
"company_name": {
"type": "string"
},
"id": {
"type": "string"
},
"phone": {
"type": "string"
}
}
},
"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": {
"company_name": {
"description": "企业基本信息",
"type": "string"
},
"enterprise_address": {
"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"
},
"unified_social_code": {
"description": "统一社会信用代码",
"type": "string"
}
}
},
"value_objects.InvoiceInfo": {
"type": "object",
"properties": {
"bank_account": {
"description": "基本开户账号",
"type": "string"
},
"bank_name": {
"description": "基本开户银行",
"type": "string"
},
"company_address": {
"description": "企业注册地址",
"type": "string"
},
"company_name": {
"description": "公司名称",
"type": "string"
},
"company_phone": {
"description": "企业注册电话",
"type": "string"
},
"receiving_email": {
"description": "发票接收邮箱",
"type": "string"
},
"taxpayer_id": {
"description": "纳税人识别号",
"type": "string"
}
}
},
"value_objects.InvoiceType": {
"type": "string",
"enum": [
"general",
"special"
],
"x-enum-comments": {
"InvoiceTypeGeneral": "增值税普通发票 (普票)",
"InvoiceTypeSpecial": "增值税专用发票 (专票)"
},
"x-enum-descriptions": [
"增值税普通发票 (普票)",
"增值税专用发票 (专票)"
],
"x-enum-varnames": [
"InvoiceTypeGeneral",
"InvoiceTypeSpecial"
]
}
},
"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)
}
Reference in New Issue View Git Blame Copy Permalink