first commit
This commit is contained in:
954
service/backend/docs/docs.go
Normal file
954
service/backend/docs/docs.go
Normal file
@@ -0,0 +1,954 @@
|
||||
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
|
||||
// This file was generated by swaggo/swag
|
||||
|
||||
package docs
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"strings"
|
||||
|
||||
"github.com/alecthomas/template"
|
||||
"github.com/swaggo/swag"
|
||||
)
|
||||
|
||||
var doc = `{
|
||||
"schemes": {{ marshal .Schemes }},
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"description": "{{.Description}}",
|
||||
"title": "{{.Title}}",
|
||||
"contact": {},
|
||||
"version": "{{.Version}}"
|
||||
},
|
||||
"host": "{{.Host}}",
|
||||
"basePath": "{{.BasePath}}",
|
||||
"paths": {
|
||||
"/app/cdk/create-cdk-order": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk App"
|
||||
],
|
||||
"summary": "创建兑换订单",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "MOCK",
|
||||
"name": "FZM-SIGNATURE",
|
||||
"in": "header",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.CreateCdkOrderReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.CreateCdkOrderResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/app/cdk/deal-cdk-order": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk App"
|
||||
],
|
||||
"summary": "处理兑换订单",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "MOCK",
|
||||
"name": "FZM-SIGNATURE",
|
||||
"in": "header",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.DealCdkOrderReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.DealCdkOrderResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/app/cdk/get-cdk-type-by-coin-name": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk App"
|
||||
],
|
||||
"summary": "查询一个票券对应的 cdkType",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.GetCdkTypeByCoinNameReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.GetCdkTypeByCoinNameResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/app/cdk/get-cdks-by-user-id": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk App"
|
||||
],
|
||||
"summary": "分页获得一个人拥有的 cdks",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "MOCK",
|
||||
"name": "FZM-SIGNATURE",
|
||||
"in": "header",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.GetCdksByUserIdReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.GetCdksByUserIdResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/create-cdk-type": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "创建 CdkType",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.CreateCdkTypeReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.CreateCdkTypeResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/create-cdks": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "创建 Cdks",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.CreateCdksReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.CreateCdksResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/delete-cdk-types": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "删除 cdkTypes",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.DeleteCdkTypesReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.DeleteCdkTypesResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/delete-cdks": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "删除 cdks",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.DeleteCdksReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.DeleteCdksResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/exchange-cdks": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "兑换 cdks",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.ExchangeCdksReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.ExchangeCdksResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/get-cdk-types": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 查询"
|
||||
],
|
||||
"summary": "分页获得 cdkType",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.GetCdkTypesReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.GetCdkTypesResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/get-cdks": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 查询"
|
||||
],
|
||||
"summary": "分页获得 cdks",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.GetCdksReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.GetCdksResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/update-cdk-type": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "更新 cdkType",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.UpdateCdkTypeReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.UpdateCdkTypeResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"types.Cdk": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdkContent": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkName": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkStatus": {
|
||||
"type": "integer"
|
||||
},
|
||||
"createTime": {
|
||||
"type": "string"
|
||||
},
|
||||
"exchangeTime": {
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"orderId": {
|
||||
"type": "string"
|
||||
},
|
||||
"userId": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CdkType": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdkAvailable": {
|
||||
"description": "未发放的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"cdkFrozen": {
|
||||
"description": "冻结状态中的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkInfo": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkName": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkUsed": {
|
||||
"description": "已发放的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
},
|
||||
"exchangeRate": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdkOrderReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"cdkId",
|
||||
"number"
|
||||
],
|
||||
"properties": {
|
||||
"cdkId": {
|
||||
"description": "cdk 种类编号",
|
||||
"type": "string"
|
||||
},
|
||||
"number": {
|
||||
"description": "兑换数量",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdkOrderResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"orderId": {
|
||||
"description": "订单编号",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdkTypeReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"coinName",
|
||||
"exchangeRate"
|
||||
],
|
||||
"properties": {
|
||||
"cdkInfo": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkName": {
|
||||
"type": "string"
|
||||
},
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
},
|
||||
"exchangeRate": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdkTypeResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdksReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"cdkContents",
|
||||
"cdkId"
|
||||
],
|
||||
"properties": {
|
||||
"cdkContents": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdksResp": {
|
||||
"type": "object"
|
||||
},
|
||||
"types.DealCdkOrderReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"orderId",
|
||||
"transferHash"
|
||||
],
|
||||
"properties": {
|
||||
"orderId": {
|
||||
"description": "订单编号",
|
||||
"type": "string"
|
||||
},
|
||||
"result": {
|
||||
"description": "处理结果",
|
||||
"type": "boolean"
|
||||
},
|
||||
"transferHash": {
|
||||
"description": "转账记录 hash",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.DealCdkOrderResp": {
|
||||
"type": "object"
|
||||
},
|
||||
"types.DeleteCdkTypesReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"cdkIds"
|
||||
],
|
||||
"properties": {
|
||||
"cdkIds": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.DeleteCdkTypesResp": {
|
||||
"type": "object"
|
||||
},
|
||||
"types.DeleteCdksReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"ids"
|
||||
],
|
||||
"properties": {
|
||||
"ids": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.DeleteCdksResp": {
|
||||
"type": "object"
|
||||
},
|
||||
"types.ExchangeCdksReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"ids"
|
||||
],
|
||||
"properties": {
|
||||
"ids": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.ExchangeCdksResp": {
|
||||
"type": "object"
|
||||
},
|
||||
"types.GeneralResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "object"
|
||||
},
|
||||
"message": {
|
||||
"type": "integer"
|
||||
},
|
||||
"result": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdkTypeByCoinNameReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"coinName"
|
||||
],
|
||||
"properties": {
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdkTypeByCoinNameResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdkAvailable": {
|
||||
"description": "未发放的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"cdkFrozen": {
|
||||
"description": "冻结状态中的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkInfo": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkName": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkUsed": {
|
||||
"description": "已发放的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
},
|
||||
"exchangeRate": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdkTypesReq": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
},
|
||||
"page": {
|
||||
"description": "页数",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "每页数量",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdkTypesResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdkTypes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/types.CdkType"
|
||||
}
|
||||
},
|
||||
"totalElements": {
|
||||
"type": "integer"
|
||||
},
|
||||
"totalPages": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdksByUserIdReq": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"page": {
|
||||
"description": "页数",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "每页数量",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdksByUserIdResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdks": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/types.Cdk"
|
||||
}
|
||||
},
|
||||
"totalElements": {
|
||||
"type": "integer"
|
||||
},
|
||||
"totalPages": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdksReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"cdkId"
|
||||
],
|
||||
"properties": {
|
||||
"cdkContent": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
},
|
||||
"page": {
|
||||
"description": "页数",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "每页数量",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdksResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdks": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/types.Cdk"
|
||||
}
|
||||
},
|
||||
"totalElements": {
|
||||
"type": "integer"
|
||||
},
|
||||
"totalPages": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.UpdateCdkTypeReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"cdkId",
|
||||
"cdkName",
|
||||
"coinName",
|
||||
"exchangeRate"
|
||||
],
|
||||
"properties": {
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkName": {
|
||||
"type": "string"
|
||||
},
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
},
|
||||
"exchangeRate": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.UpdateCdkTypeResp": {
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
}`
|
||||
|
||||
type swaggerInfo struct {
|
||||
Version string
|
||||
Host string
|
||||
BasePath string
|
||||
Schemes []string
|
||||
Title string
|
||||
Description string
|
||||
}
|
||||
|
||||
// SwaggerInfo holds exported Swagger Info so clients can modify it
|
||||
var SwaggerInfo = swaggerInfo{
|
||||
Version: "",
|
||||
Host: "",
|
||||
BasePath: "",
|
||||
Schemes: []string{},
|
||||
Title: "",
|
||||
Description: "",
|
||||
}
|
||||
|
||||
type s struct{}
|
||||
|
||||
func (s *s) ReadDoc() string {
|
||||
sInfo := SwaggerInfo
|
||||
sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1)
|
||||
|
||||
t, err := template.New("swagger_info").Funcs(template.FuncMap{
|
||||
"marshal": func(v interface{}) string {
|
||||
a, _ := json.Marshal(v)
|
||||
return string(a)
|
||||
},
|
||||
}).Parse(doc)
|
||||
if err != nil {
|
||||
return doc
|
||||
}
|
||||
|
||||
var tpl bytes.Buffer
|
||||
if err := t.Execute(&tpl, sInfo); err != nil {
|
||||
return doc
|
||||
}
|
||||
|
||||
return tpl.String()
|
||||
}
|
||||
|
||||
func init() {
|
||||
swag.Register(swag.Name, &s{})
|
||||
}
|
||||
887
service/backend/docs/swagger.json
Normal file
887
service/backend/docs/swagger.json
Normal file
@@ -0,0 +1,887 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"contact": {}
|
||||
},
|
||||
"paths": {
|
||||
"/app/cdk/create-cdk-order": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk App"
|
||||
],
|
||||
"summary": "创建兑换订单",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "MOCK",
|
||||
"name": "FZM-SIGNATURE",
|
||||
"in": "header",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.CreateCdkOrderReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.CreateCdkOrderResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/app/cdk/deal-cdk-order": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk App"
|
||||
],
|
||||
"summary": "处理兑换订单",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "MOCK",
|
||||
"name": "FZM-SIGNATURE",
|
||||
"in": "header",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.DealCdkOrderReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.DealCdkOrderResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/app/cdk/get-cdk-type-by-coin-name": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk App"
|
||||
],
|
||||
"summary": "查询一个票券对应的 cdkType",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.GetCdkTypeByCoinNameReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.GetCdkTypeByCoinNameResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/app/cdk/get-cdks-by-user-id": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk App"
|
||||
],
|
||||
"summary": "分页获得一个人拥有的 cdks",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "MOCK",
|
||||
"name": "FZM-SIGNATURE",
|
||||
"in": "header",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.GetCdksByUserIdReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.GetCdksByUserIdResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/create-cdk-type": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "创建 CdkType",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.CreateCdkTypeReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.CreateCdkTypeResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/create-cdks": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "创建 Cdks",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.CreateCdksReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.CreateCdksResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/delete-cdk-types": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "删除 cdkTypes",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.DeleteCdkTypesReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.DeleteCdkTypesResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/delete-cdks": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "删除 cdks",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.DeleteCdksReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.DeleteCdksResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/exchange-cdks": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "兑换 cdks",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.ExchangeCdksReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.ExchangeCdksResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/get-cdk-types": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 查询"
|
||||
],
|
||||
"summary": "分页获得 cdkType",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.GetCdkTypesReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.GetCdkTypesResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/get-cdks": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 查询"
|
||||
],
|
||||
"summary": "分页获得 cdks",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.GetCdksReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.GetCdksResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/backend/cdk/update-cdk-type": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Cdk 后台"
|
||||
],
|
||||
"summary": "更新 cdkType",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "body",
|
||||
"name": "data",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/types.UpdateCdkTypeReq"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "OK",
|
||||
"schema": {
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/types.GeneralResponse"
|
||||
},
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"$ref": "#/definitions/types.UpdateCdkTypeResp"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"types.Cdk": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdkContent": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkName": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkStatus": {
|
||||
"type": "integer"
|
||||
},
|
||||
"createTime": {
|
||||
"type": "string"
|
||||
},
|
||||
"exchangeTime": {
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"type": "string"
|
||||
},
|
||||
"orderId": {
|
||||
"type": "string"
|
||||
},
|
||||
"userId": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CdkType": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdkAvailable": {
|
||||
"description": "未发放的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"cdkFrozen": {
|
||||
"description": "冻结状态中的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkInfo": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkName": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkUsed": {
|
||||
"description": "已发放的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
},
|
||||
"exchangeRate": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdkOrderReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"cdkId",
|
||||
"number"
|
||||
],
|
||||
"properties": {
|
||||
"cdkId": {
|
||||
"description": "cdk 种类编号",
|
||||
"type": "string"
|
||||
},
|
||||
"number": {
|
||||
"description": "兑换数量",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdkOrderResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"orderId": {
|
||||
"description": "订单编号",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdkTypeReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"coinName",
|
||||
"exchangeRate"
|
||||
],
|
||||
"properties": {
|
||||
"cdkInfo": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkName": {
|
||||
"type": "string"
|
||||
},
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
},
|
||||
"exchangeRate": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdkTypeResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdksReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"cdkContents",
|
||||
"cdkId"
|
||||
],
|
||||
"properties": {
|
||||
"cdkContents": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.CreateCdksResp": {
|
||||
"type": "object"
|
||||
},
|
||||
"types.DealCdkOrderReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"orderId",
|
||||
"transferHash"
|
||||
],
|
||||
"properties": {
|
||||
"orderId": {
|
||||
"description": "订单编号",
|
||||
"type": "string"
|
||||
},
|
||||
"result": {
|
||||
"description": "处理结果",
|
||||
"type": "boolean"
|
||||
},
|
||||
"transferHash": {
|
||||
"description": "转账记录 hash",
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.DealCdkOrderResp": {
|
||||
"type": "object"
|
||||
},
|
||||
"types.DeleteCdkTypesReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"cdkIds"
|
||||
],
|
||||
"properties": {
|
||||
"cdkIds": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.DeleteCdkTypesResp": {
|
||||
"type": "object"
|
||||
},
|
||||
"types.DeleteCdksReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"ids"
|
||||
],
|
||||
"properties": {
|
||||
"ids": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.DeleteCdksResp": {
|
||||
"type": "object"
|
||||
},
|
||||
"types.ExchangeCdksReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"ids"
|
||||
],
|
||||
"properties": {
|
||||
"ids": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.ExchangeCdksResp": {
|
||||
"type": "object"
|
||||
},
|
||||
"types.GeneralResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "object"
|
||||
},
|
||||
"message": {
|
||||
"type": "integer"
|
||||
},
|
||||
"result": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdkTypeByCoinNameReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"coinName"
|
||||
],
|
||||
"properties": {
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdkTypeByCoinNameResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdkAvailable": {
|
||||
"description": "未发放的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"cdkFrozen": {
|
||||
"description": "冻结状态中的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkInfo": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkName": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkUsed": {
|
||||
"description": "已发放的cdk数量",
|
||||
"type": "integer"
|
||||
},
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
},
|
||||
"exchangeRate": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdkTypesReq": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
},
|
||||
"page": {
|
||||
"description": "页数",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "每页数量",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdkTypesResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdkTypes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/types.CdkType"
|
||||
}
|
||||
},
|
||||
"totalElements": {
|
||||
"type": "integer"
|
||||
},
|
||||
"totalPages": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdksByUserIdReq": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"page": {
|
||||
"description": "页数",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "每页数量",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdksByUserIdResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdks": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/types.Cdk"
|
||||
}
|
||||
},
|
||||
"totalElements": {
|
||||
"type": "integer"
|
||||
},
|
||||
"totalPages": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdksReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"cdkId"
|
||||
],
|
||||
"properties": {
|
||||
"cdkContent": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
},
|
||||
"page": {
|
||||
"description": "页数",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "每页数量",
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.GetCdksResp": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"cdks": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/types.Cdk"
|
||||
}
|
||||
},
|
||||
"totalElements": {
|
||||
"type": "integer"
|
||||
},
|
||||
"totalPages": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.UpdateCdkTypeReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"cdkId",
|
||||
"cdkName",
|
||||
"coinName",
|
||||
"exchangeRate"
|
||||
],
|
||||
"properties": {
|
||||
"cdkId": {
|
||||
"type": "string"
|
||||
},
|
||||
"cdkName": {
|
||||
"type": "string"
|
||||
},
|
||||
"coinName": {
|
||||
"type": "string"
|
||||
},
|
||||
"exchangeRate": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"types.UpdateCdkTypeResp": {
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
}
|
||||
540
service/backend/docs/swagger.yaml
Normal file
540
service/backend/docs/swagger.yaml
Normal file
@@ -0,0 +1,540 @@
|
||||
definitions:
|
||||
types.Cdk:
|
||||
properties:
|
||||
cdkContent:
|
||||
type: string
|
||||
cdkId:
|
||||
type: string
|
||||
cdkName:
|
||||
type: string
|
||||
cdkStatus:
|
||||
type: integer
|
||||
createTime:
|
||||
type: string
|
||||
exchangeTime:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
orderId:
|
||||
type: string
|
||||
userId:
|
||||
type: string
|
||||
type: object
|
||||
types.CdkType:
|
||||
properties:
|
||||
cdkAvailable:
|
||||
description: 未发放的cdk数量
|
||||
type: integer
|
||||
cdkFrozen:
|
||||
description: 冻结状态中的cdk数量
|
||||
type: integer
|
||||
cdkId:
|
||||
type: string
|
||||
cdkInfo:
|
||||
type: string
|
||||
cdkName:
|
||||
type: string
|
||||
cdkUsed:
|
||||
description: 已发放的cdk数量
|
||||
type: integer
|
||||
coinName:
|
||||
type: string
|
||||
exchangeRate:
|
||||
type: integer
|
||||
type: object
|
||||
types.CreateCdkOrderReq:
|
||||
properties:
|
||||
cdkId:
|
||||
description: cdk 种类编号
|
||||
type: string
|
||||
number:
|
||||
description: 兑换数量
|
||||
type: integer
|
||||
required:
|
||||
- cdkId
|
||||
- number
|
||||
type: object
|
||||
types.CreateCdkOrderResp:
|
||||
properties:
|
||||
orderId:
|
||||
description: 订单编号
|
||||
type: string
|
||||
type: object
|
||||
types.CreateCdkTypeReq:
|
||||
properties:
|
||||
cdkInfo:
|
||||
type: string
|
||||
cdkName:
|
||||
type: string
|
||||
coinName:
|
||||
type: string
|
||||
exchangeRate:
|
||||
type: integer
|
||||
required:
|
||||
- coinName
|
||||
- exchangeRate
|
||||
type: object
|
||||
types.CreateCdkTypeResp:
|
||||
properties:
|
||||
cdkId:
|
||||
type: string
|
||||
type: object
|
||||
types.CreateCdksReq:
|
||||
properties:
|
||||
cdkContents:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
cdkId:
|
||||
type: string
|
||||
required:
|
||||
- cdkContents
|
||||
- cdkId
|
||||
type: object
|
||||
types.CreateCdksResp:
|
||||
type: object
|
||||
types.DealCdkOrderReq:
|
||||
properties:
|
||||
orderId:
|
||||
description: 订单编号
|
||||
type: string
|
||||
result:
|
||||
description: 处理结果
|
||||
type: boolean
|
||||
transferHash:
|
||||
description: 转账记录 hash
|
||||
type: string
|
||||
required:
|
||||
- orderId
|
||||
- transferHash
|
||||
type: object
|
||||
types.DealCdkOrderResp:
|
||||
type: object
|
||||
types.DeleteCdkTypesReq:
|
||||
properties:
|
||||
cdkIds:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
required:
|
||||
- cdkIds
|
||||
type: object
|
||||
types.DeleteCdkTypesResp:
|
||||
type: object
|
||||
types.DeleteCdksReq:
|
||||
properties:
|
||||
ids:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
required:
|
||||
- ids
|
||||
type: object
|
||||
types.DeleteCdksResp:
|
||||
type: object
|
||||
types.ExchangeCdksReq:
|
||||
properties:
|
||||
ids:
|
||||
items:
|
||||
type: string
|
||||
type: array
|
||||
required:
|
||||
- ids
|
||||
type: object
|
||||
types.ExchangeCdksResp:
|
||||
type: object
|
||||
types.GeneralResponse:
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
message:
|
||||
type: integer
|
||||
result:
|
||||
type: integer
|
||||
type: object
|
||||
types.GetCdkTypeByCoinNameReq:
|
||||
properties:
|
||||
coinName:
|
||||
type: string
|
||||
required:
|
||||
- coinName
|
||||
type: object
|
||||
types.GetCdkTypeByCoinNameResp:
|
||||
properties:
|
||||
cdkAvailable:
|
||||
description: 未发放的cdk数量
|
||||
type: integer
|
||||
cdkFrozen:
|
||||
description: 冻结状态中的cdk数量
|
||||
type: integer
|
||||
cdkId:
|
||||
type: string
|
||||
cdkInfo:
|
||||
type: string
|
||||
cdkName:
|
||||
type: string
|
||||
cdkUsed:
|
||||
description: 已发放的cdk数量
|
||||
type: integer
|
||||
coinName:
|
||||
type: string
|
||||
exchangeRate:
|
||||
type: integer
|
||||
type: object
|
||||
types.GetCdkTypesReq:
|
||||
properties:
|
||||
coinName:
|
||||
type: string
|
||||
page:
|
||||
description: 页数
|
||||
type: integer
|
||||
pageSize:
|
||||
description: 每页数量
|
||||
type: integer
|
||||
type: object
|
||||
types.GetCdkTypesResp:
|
||||
properties:
|
||||
cdkTypes:
|
||||
items:
|
||||
$ref: '#/definitions/types.CdkType'
|
||||
type: array
|
||||
totalElements:
|
||||
type: integer
|
||||
totalPages:
|
||||
type: integer
|
||||
type: object
|
||||
types.GetCdksByUserIdReq:
|
||||
properties:
|
||||
page:
|
||||
description: 页数
|
||||
type: integer
|
||||
pageSize:
|
||||
description: 每页数量
|
||||
type: integer
|
||||
type: object
|
||||
types.GetCdksByUserIdResp:
|
||||
properties:
|
||||
cdks:
|
||||
items:
|
||||
$ref: '#/definitions/types.Cdk'
|
||||
type: array
|
||||
totalElements:
|
||||
type: integer
|
||||
totalPages:
|
||||
type: integer
|
||||
type: object
|
||||
types.GetCdksReq:
|
||||
properties:
|
||||
cdkContent:
|
||||
type: string
|
||||
cdkId:
|
||||
type: string
|
||||
page:
|
||||
description: 页数
|
||||
type: integer
|
||||
pageSize:
|
||||
description: 每页数量
|
||||
type: integer
|
||||
required:
|
||||
- cdkId
|
||||
type: object
|
||||
types.GetCdksResp:
|
||||
properties:
|
||||
cdks:
|
||||
items:
|
||||
$ref: '#/definitions/types.Cdk'
|
||||
type: array
|
||||
totalElements:
|
||||
type: integer
|
||||
totalPages:
|
||||
type: integer
|
||||
type: object
|
||||
types.UpdateCdkTypeReq:
|
||||
properties:
|
||||
cdkId:
|
||||
type: string
|
||||
cdkName:
|
||||
type: string
|
||||
coinName:
|
||||
type: string
|
||||
exchangeRate:
|
||||
type: integer
|
||||
required:
|
||||
- cdkId
|
||||
- cdkName
|
||||
- coinName
|
||||
- exchangeRate
|
||||
type: object
|
||||
types.UpdateCdkTypeResp:
|
||||
type: object
|
||||
info:
|
||||
contact: {}
|
||||
paths:
|
||||
/app/cdk/create-cdk-order:
|
||||
post:
|
||||
parameters:
|
||||
- description: MOCK
|
||||
in: header
|
||||
name: FZM-SIGNATURE
|
||||
required: true
|
||||
type: string
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.CreateCdkOrderReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.CreateCdkOrderResp'
|
||||
type: object
|
||||
summary: 创建兑换订单
|
||||
tags:
|
||||
- Cdk App
|
||||
/app/cdk/deal-cdk-order:
|
||||
post:
|
||||
parameters:
|
||||
- description: MOCK
|
||||
in: header
|
||||
name: FZM-SIGNATURE
|
||||
required: true
|
||||
type: string
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.DealCdkOrderReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.DealCdkOrderResp'
|
||||
type: object
|
||||
summary: 处理兑换订单
|
||||
tags:
|
||||
- Cdk App
|
||||
/app/cdk/get-cdk-type-by-coin-name:
|
||||
post:
|
||||
parameters:
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.GetCdkTypeByCoinNameReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.GetCdkTypeByCoinNameResp'
|
||||
type: object
|
||||
summary: 查询一个票券对应的 cdkType
|
||||
tags:
|
||||
- Cdk App
|
||||
/app/cdk/get-cdks-by-user-id:
|
||||
post:
|
||||
parameters:
|
||||
- description: MOCK
|
||||
in: header
|
||||
name: FZM-SIGNATURE
|
||||
required: true
|
||||
type: string
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.GetCdksByUserIdReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.GetCdksByUserIdResp'
|
||||
type: object
|
||||
summary: 分页获得一个人拥有的 cdks
|
||||
tags:
|
||||
- Cdk App
|
||||
/backend/cdk/create-cdk-type:
|
||||
post:
|
||||
parameters:
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.CreateCdkTypeReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.CreateCdkTypeResp'
|
||||
type: object
|
||||
summary: 创建 CdkType
|
||||
tags:
|
||||
- Cdk 后台
|
||||
/backend/cdk/create-cdks:
|
||||
post:
|
||||
parameters:
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.CreateCdksReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.CreateCdksResp'
|
||||
type: object
|
||||
summary: 创建 Cdks
|
||||
tags:
|
||||
- Cdk 后台
|
||||
/backend/cdk/delete-cdk-types:
|
||||
post:
|
||||
parameters:
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.DeleteCdkTypesReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.DeleteCdkTypesResp'
|
||||
type: object
|
||||
summary: 删除 cdkTypes
|
||||
tags:
|
||||
- Cdk 后台
|
||||
/backend/cdk/delete-cdks:
|
||||
post:
|
||||
parameters:
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.DeleteCdksReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.DeleteCdksResp'
|
||||
type: object
|
||||
summary: 删除 cdks
|
||||
tags:
|
||||
- Cdk 后台
|
||||
/backend/cdk/exchange-cdks:
|
||||
post:
|
||||
parameters:
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.ExchangeCdksReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.ExchangeCdksResp'
|
||||
type: object
|
||||
summary: 兑换 cdks
|
||||
tags:
|
||||
- Cdk 后台
|
||||
/backend/cdk/get-cdk-types:
|
||||
post:
|
||||
parameters:
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.GetCdkTypesReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.GetCdkTypesResp'
|
||||
type: object
|
||||
summary: 分页获得 cdkType
|
||||
tags:
|
||||
- Cdk 查询
|
||||
/backend/cdk/get-cdks:
|
||||
post:
|
||||
parameters:
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.GetCdksReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.GetCdksResp'
|
||||
type: object
|
||||
summary: 分页获得 cdks
|
||||
tags:
|
||||
- Cdk 查询
|
||||
/backend/cdk/update-cdk-type:
|
||||
post:
|
||||
parameters:
|
||||
- description: body
|
||||
in: body
|
||||
name: data
|
||||
schema:
|
||||
$ref: '#/definitions/types.UpdateCdkTypeReq'
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/types.GeneralResponse'
|
||||
- properties:
|
||||
data:
|
||||
$ref: '#/definitions/types.UpdateCdkTypeResp'
|
||||
type: object
|
||||
summary: 更新 cdkType
|
||||
tags:
|
||||
- Cdk 后台
|
||||
swagger: "2.0"
|
||||
Reference in New Issue
Block a user