Daniel/hailin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
hailin/internal/swagger/docs.go
Daniel 91436ca88a first commit
2025-06-19 10:30:46 +08:00

5437 lines
188 KiB
Go
Raw Blame History

// Package swagger Code generated by swaggo/swag. DO NOT EDIT
package swagger
import "github.com/swaggo/swag"
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/api/v1/articles": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"ArticleAPI"
],
"summary": "Query Article list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "name of Article",
"name": "name",
"in": "query"
},
{
"type": "string",
"description": "Status of banner (disabled,enabled)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Article"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"ArticleAPI"
],
"summary": "Create Article record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.ArticleForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Article"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/articles/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"ArticleAPI"
],
"summary": "Get Article record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Article"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"ArticleAPI"
],
"summary": "Update Article record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.ArticleForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"ArticleAPI"
],
"summary": "Delete Article record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/banners": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"BannerAPI"
],
"summary": "Query banner list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Name of banner",
"name": "name",
"in": "query"
},
{
"type": "string",
"description": "Status of banner (disabled,enabled)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Banner"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"BannerAPI"
],
"summary": "Create banner record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.BannerForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Banner"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/banners/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"BannerAPI"
],
"summary": "Get banner record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Banner"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"BannerAPI"
],
"summary": "Update banner record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.BannerForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"BannerAPI"
],
"summary": "Delete banner record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/captcha/id": {
"get": {
"tags": [
"LoginAPI"
],
"summary": "Get captcha ID",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Captcha"
}
}
}
]
}
}
}
}
},
"/api/v1/captcha/image": {
"get": {
"produces": [
"image/png"
],
"tags": [
"LoginAPI"
],
"summary": "Response captcha image",
"parameters": [
{
"type": "string",
"description": "Captcha ID",
"name": "id",
"in": "query",
"required": true
},
{
"type": "number",
"description": "Reload captcha image (reload=1)",
"name": "reload",
"in": "query"
}
],
"responses": {
"200": {
"description": "Captcha image"
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/current/logout": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"LoginAPI"
],
"summary": "Logout system",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/current/menus": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"LoginAPI"
],
"summary": "Query current user menus based on the current user role",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Menu"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/current/password": {
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"LoginAPI"
],
"summary": "Change current user password",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.UpdateLoginPassword"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/current/refresh-token": {
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"LoginAPI"
],
"summary": "Refresh current access token",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.LoginToken"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/current/user": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"LoginAPI"
],
"summary": "Get current user info",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.User"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"LoginAPI"
],
"summary": "Update current user info",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.UpdateCurrentUser"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/jobs": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"职位模块"
],
"summary": "Query Job list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "title of Job",
"name": "title",
"in": "query"
},
{
"type": "string",
"description": "jobAreaId of Job",
"name": "jobAreaId",
"in": "query"
},
{
"type": "string",
"description": "Status of banner (disabled,enabled)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Job"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"职位模块"
],
"summary": "Create Job record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.JobForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Job"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/jobs/job_areas": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"职位模块"
],
"summary": "Query JobArea list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Status of banner (disabled,enabled)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.JobArea"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"职位模块"
],
"summary": "Create JobArea record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.JobAreaForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.JobAreaForm"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/jobs/job_areas/{id}": {
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"职位模块"
],
"summary": "Update JobArea record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.JobAreaForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"职位模块"
],
"summary": "Delete JobArea record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/jobs/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"职位模块"
],
"summary": "Get Job record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Job"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"职位模块"
],
"summary": "Update Job record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.JobForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"职位模块"
],
"summary": "Delete Job record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/loggers": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"LoggerAPI"
],
"summary": "Query logger list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "log level",
"name": "level",
"in": "query"
},
{
"type": "string",
"description": "trace ID",
"name": "traceID",
"in": "query"
},
{
"type": "string",
"description": "user name",
"name": "userName",
"in": "query"
},
{
"type": "string",
"description": "log tag",
"name": "tag",
"in": "query"
},
{
"type": "string",
"description": "log message",
"name": "message",
"in": "query"
},
{
"type": "string",
"description": "start time",
"name": "startTime",
"in": "query"
},
{
"type": "string",
"description": "end time",
"name": "endTime",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Logger"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/login": {
"post": {
"tags": [
"LoginAPI"
],
"summary": "Login system with username and password",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.LoginForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.LoginToken"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/memorabilias": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"发展历程模块"
],
"summary": "Query Memorabilia list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "title of Memorabilia",
"name": "title",
"in": "query"
},
{
"type": "string",
"description": "month of Memorabilia",
"name": "month",
"in": "query"
},
{
"type": "string",
"description": "year of Memorabilia",
"name": "year",
"in": "query"
},
{
"type": "string",
"description": "Status of banner (disabled,enabled)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Memorabilia"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"发展历程模块"
],
"summary": "Create Article record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.MemorabiliaForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Memorabilia"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/memorabilias/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"发展历程模块"
],
"summary": "Get Memorabilia record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Memorabilia"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"发展历程模块"
],
"summary": "Update Article record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.MemorabiliaForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"发展历程模块"
],
"summary": "Delete Article record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/menus": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"MenuAPI"
],
"summary": "Query menu tree data",
"parameters": [
{
"type": "string",
"description": "Code path of menu (like xxx.xxx.xxx)",
"name": "code",
"in": "query"
},
{
"type": "string",
"description": "Name of menu",
"name": "name",
"in": "query"
},
{
"type": "boolean",
"description": "Whether to include menu resources",
"name": "includeResources",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Menu"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"MenuAPI"
],
"summary": "Create menu record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.MenuForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Menu"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/menus/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"MenuAPI"
],
"summary": "Get menu record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Menu"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"MenuAPI"
],
"summary": "Update menu record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.MenuForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"MenuAPI"
],
"summary": "Delete menu record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/products": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"产品模块"
],
"summary": "Query Product list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "title of Product",
"name": "title",
"in": "query"
},
{
"type": "integer",
"description": "categoryId of Product",
"name": "categoryId",
"in": "query"
},
{
"type": "string",
"description": "code of Product",
"name": "code",
"in": "query"
},
{
"type": "string",
"description": "Status of Product (disabled,enabled)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Product"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"产品模块"
],
"summary": "Create Product record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.ProductForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Product"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/products/categorys": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"产品模块"
],
"summary": "Query ProductCategory list",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.ProductCategory"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/products/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"产品模块"
],
"summary": "Get Product record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Product"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"产品模块"
],
"summary": "Update Product record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.ProductForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"产品模块"
],
"summary": "Delete Product record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/roles": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"RoleAPI"
],
"summary": "Query role list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Display name of role",
"name": "name",
"in": "query"
},
{
"type": "string",
"description": "Status of role (disabled, enabled)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Role"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"RoleAPI"
],
"summary": "Create role record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.RoleForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Role"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/roles/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"RoleAPI"
],
"summary": "Get role record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Role"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"RoleAPI"
],
"summary": "Update role record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.RoleForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"RoleAPI"
],
"summary": "Delete role record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/teams": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"团队模块"
],
"summary": "Query Team list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "name of Team",
"name": "name",
"in": "query"
},
{
"type": "string",
"description": "Status of banner (disabled,enabled)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Team"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"团队模块"
],
"summary": "Create Article record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.TeamForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Team"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/teams/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"团队模块"
],
"summary": "Get Team record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Team"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"团队模块"
],
"summary": "Update Article record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.TeamForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"团队模块"
],
"summary": "Delete Article record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/users": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"UserAPI"
],
"summary": "Query user list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Username for login",
"name": "username",
"in": "query"
},
{
"type": "string",
"description": "Name of user",
"name": "name",
"in": "query"
},
{
"type": "string",
"description": "Status of user (activated, freezed)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.User"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"UserAPI"
],
"summary": "Create user record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.UserForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.User"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/users/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"UserAPI"
],
"summary": "Get user record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.User"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"UserAPI"
],
"summary": "Update user record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.UserForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"UserAPI"
],
"summary": "Delete user record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/users/{id}/reset-pwd": {
"patch": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"UserAPI"
],
"summary": "Reset user password by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/videos": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"VideoAPI"
],
"summary": "Query Video list",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "title of Video",
"name": "title",
"in": "query"
},
{
"type": "string",
"description": "Status of banner (disabled,enabled)",
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Video"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"VideoAPI"
],
"summary": "Create banner record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.VideoForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Video"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/videos/{id}": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"VideoAPI"
],
"summary": "Get Video record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.Video"
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"VideoAPI"
],
"summary": "Update Video record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.BannerForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"VideoAPI"
],
"summary": "Delete Video record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/web/articles": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"网页模块"
],
"summary": "获取公司动态",
"parameters": [
{
"type": "integer",
"default": 1,
"description": "pagination index",
"name": "current",
"in": "query",
"required": true
},
{
"type": "integer",
"default": 10,
"description": "pagination size",
"name": "pageSize",
"in": "query",
"required": true
},
{
"type": "string",
"description": "jobAreaId of Job",
"name": "jobAreaId",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Article"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/web/jobs": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"网页模块"
],
"summary": "获取职位列表",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.WebJobData"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/web_site": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"网页设置"
],
"summary": "Query WebSite info",
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.WebSite"
}
}
}
}
]
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
},
"post": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"ArticleAPI"
],
"summary": "Create WebSite record",
"parameters": [
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.WebSiteForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"allOf": [
{
"$ref": "#/definitions/util.ResponseResult"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/schema.WebSite"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
},
"/api/v1/web_site/{id}": {
"put": {
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
"网页设置"
],
"summary": "Update WebSite record by ID",
"parameters": [
{
"type": "string",
"description": "unique id",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Request body",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/schema.WebSiteForm"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/util.ResponseResult"
}
}
}
}
}
},
"definitions": {
"errors.Error": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"detail": {
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"schema.Article": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"created_at": {
"description": "Create time",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"img": {
"description": "Details about banner",
"type": "string"
},
"link": {
"type": "string"
},
"pushAt": {
"type": "string"
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"status": {
"description": "Status of banner (enabled, disabled) // Child menus",
"type": "string"
},
"title": {
"description": "Display name of banner",
"type": "string"
},
"type": {
"description": "Type of banner (banner, link) // Parent menu` + "`" + `` + "`" + `",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
}
}
},
"schema.ArticleForm": {
"type": "object",
"required": [
"status",
"title",
"type"
],
"properties": {
"content": {
"type": "string"
},
"img": {
"description": "Details about banner",
"type": "string"
},
"link": {
"type": "string"
},
"pushAt": {
"type": "string"
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"status": {
"description": "Status of menu (enabled, disabled)",
"type": "string",
"enum": [
"disabled",
"enabled"
]
},
"title": {
"description": "Display name of menu",
"type": "string",
"maxLength": 128
},
"type": {
"description": "Type of menu (banner, link) // Parent menu` + "`" + `` + "`" + `",
"type": "string",
"enum": [
"banner",
"home",
"achievement",
"honor",
"talent_center",
"team",
"news"
]
}
}
},
"schema.Banner": {
"type": "object",
"properties": {
"created_at": {
"description": "Create time",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"img": {
"description": "Details about banner",
"type": "string"
},
"link": {
"type": "string"
},
"name": {
"description": "Display name of banner",
"type": "string"
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"status": {
"description": "Status of banner (enabled, disabled) // Child menus",
"type": "string"
},
"type": {
"description": "Type of banner (banner, link) // Parent menu` + "`" + `` + "`" + `",
"type": "integer"
},
"updated_at": {
"description": "Update time",
"type": "string"
}
}
},
"schema.BannerForm": {
"type": "object",
"required": [
"name",
"status",
"type"
],
"properties": {
"img": {
"description": "Details about banner",
"type": "string"
},
"link": {
"type": "string"
},
"name": {
"description": "Display name of menu",
"type": "string",
"maxLength": 128
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"status": {
"description": "Status of menu (enabled, disabled)",
"type": "string",
"enum": [
"disabled",
"enabled"
]
},
"type": {
"description": "Type of menu (banner, link) // Parent menu` + "`" + `` + "`" + `",
"type": "integer"
}
}
},
"schema.Captcha": {
"type": "object",
"properties": {
"captcha_id": {
"description": "Captcha ID",
"type": "string"
}
}
},
"schema.Job": {
"type": "object",
"properties": {
"created_at": {
"type": "string"
},
"duty": {
"description": "职责",
"type": "array",
"items": {
"type": "string"
}
},
"id": {
"description": "主键",
"type": "string"
},
"introduce": {
"description": "要求",
"type": "string"
},
"jobAreaId": {
"description": "职位地区id",
"type": "string"
},
"salary": {
"description": "薪资",
"type": "string"
},
"sequence": {
"description": "排序",
"type": "integer"
},
"status": {
"description": "状态",
"type": "string"
},
"title": {
"description": "标题",
"type": "string"
},
"updated_at": {
"type": "string"
}
}
},
"schema.JobArea": {
"type": "object",
"properties": {
"created_at": {
"description": "Create time",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"name": {
"description": "区域名字",
"type": "string"
},
"status": {
"description": "Status of banner (enabled, disabled) // Child menus",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
}
}
},
"schema.JobAreaForm": {
"type": "object",
"required": [
"name",
"status"
],
"properties": {
"name": {
"description": "Display name of menu // Details about banner",
"type": "string",
"maxLength": 128
},
"status": {
"type": "string",
"enum": [
"disabled",
"enabled"
]
}
}
},
"schema.JobForm": {
"type": "object",
"required": [
"status",
"title"
],
"properties": {
"duty": {
"type": "array",
"items": {
"type": "string"
}
},
"introduce": {
"type": "string"
},
"jobAreaId": {
"type": "string"
},
"salary": {
"description": "Details about banner",
"type": "string"
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"status": {
"description": "Status of menu (enabled, disabled)",
"type": "string",
"enum": [
"disabled",
"enabled"
]
},
"title": {
"description": "Display name of menu",
"type": "string",
"maxLength": 128
}
}
},
"schema.Logger": {
"type": "object",
"properties": {
"created_at": {
"description": "Create time",
"type": "string"
},
"data": {
"description": "Log data",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"level": {
"description": "Log level",
"type": "string"
},
"login_name": {
"description": "From User.Username",
"type": "string"
},
"message": {
"description": "Log message",
"type": "string"
},
"stack": {
"description": "Error stack",
"type": "string"
},
"tag": {
"description": "Log tag",
"type": "string"
},
"trace_id": {
"description": "Trace ID",
"type": "string"
},
"user_id": {
"description": "User ID",
"type": "string"
},
"user_name": {
"description": "From User.Name",
"type": "string"
}
}
},
"schema.LoginForm": {
"type": "object",
"required": [
"password",
"username"
],
"properties": {
"captcha_code": {
"description": "Captcha verify code",
"type": "string"
},
"captcha_id": {
"description": "Captcha verify id",
"type": "string"
},
"password": {
"description": "Login password (md5 hash)",
"type": "string"
},
"username": {
"description": "Login name",
"type": "string"
}
}
},
"schema.LoginToken": {
"type": "object",
"properties": {
"access_token": {
"description": "Access token (JWT)",
"type": "string"
},
"expires_at": {
"description": "Expired time (Unit: second)",
"type": "integer"
},
"token_type": {
"description": "Token type (Usage: Authorization=${token_type} ${access_token})",
"type": "string"
}
}
},
"schema.Memorabilia": {
"type": "object",
"properties": {
"created_at": {
"description": "Create time",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"month": {
"description": "Type of banner (banner, link) // Parent menu` + "`" + `` + "`" + `",
"type": "integer"
},
"sequence": {
"type": "integer"
},
"status": {
"description": "Status of banner (enabled, disabled) // Child menus",
"type": "string"
},
"title": {
"description": "Display name of banner",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
},
"year": {
"description": "Type of banner (banner, link) // Parent menu` + "`" + `` + "`" + `",
"type": "integer"
}
}
},
"schema.MemorabiliaForm": {
"type": "object",
"required": [
"status",
"title"
],
"properties": {
"month": {
"type": "integer"
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"status": {
"description": "Status of menu (enabled, disabled)",
"type": "string",
"enum": [
"disabled",
"enabled"
]
},
"title": {
"description": "Display name of menu",
"type": "string",
"maxLength": 128
},
"year": {
"type": "integer"
}
}
},
"schema.Menu": {
"type": "object",
"properties": {
"children": {
"description": "Child menus",
"type": "array",
"items": {
"$ref": "#/definitions/schema.Menu"
}
},
"code": {
"description": "Code of menu (unique for each level)",
"type": "string"
},
"created_at": {
"description": "Create time",
"type": "string"
},
"description": {
"description": "Details about menu",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"name": {
"description": "Display name of menu",
"type": "string"
},
"parent_id": {
"description": "Parent ID (From Menu.ID)",
"type": "string"
},
"parent_path": {
"description": "Parent path (split by .)",
"type": "string"
},
"path": {
"description": "Access path of menu",
"type": "string"
},
"properties": {
"description": "Properties of menu (JSON)",
"type": "string"
},
"resources": {
"description": "Resources of menu",
"type": "array",
"items": {
"$ref": "#/definitions/schema.MenuResource"
}
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"status": {
"description": "Status of menu (enabled, disabled)",
"type": "string"
},
"type": {
"description": "Type of menu (page, button)",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
}
}
},
"schema.MenuForm": {
"type": "object",
"required": [
"code",
"name",
"status",
"type"
],
"properties": {
"code": {
"description": "Code of menu (unique for each level)",
"type": "string",
"maxLength": 32
},
"description": {
"description": "Details about menu",
"type": "string"
},
"name": {
"description": "Display name of menu",
"type": "string",
"maxLength": 128
},
"parent_id": {
"description": "Parent ID (From Menu.ID)",
"type": "string"
},
"path": {
"description": "Access path of menu",
"type": "string"
},
"properties": {
"description": "Properties of menu (JSON)",
"type": "string"
},
"resources": {
"description": "Resources of menu",
"type": "array",
"items": {
"$ref": "#/definitions/schema.MenuResource"
}
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"status": {
"description": "Status of menu (enabled, disabled)",
"type": "string",
"enum": [
"disabled",
"enabled"
]
},
"type": {
"description": "Type of menu (page, button)",
"type": "string",
"enum": [
"page",
"button"
]
}
}
},
"schema.MenuResource": {
"type": "object",
"properties": {
"created_at": {
"description": "Create time",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"menu_id": {
"description": "From Menu.ID",
"type": "string"
},
"method": {
"description": "HTTP method",
"type": "string"
},
"path": {
"description": "API request path (e.g. /api/v1/users/:id)",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
}
}
},
"schema.Product": {
"type": "object",
"properties": {
"categoryID": {
"type": "integer"
},
"code": {
"description": "Details about banner",
"type": "string"
},
"compose": {
"type": "string"
},
"created_at": {
"description": "Create time",
"type": "string"
},
"feature": {
"description": "Type of banner (banner, link) // Parent menu` + "`" + `` + "`" + `",
"type": "string"
},
"id": {
"type": "string"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"standard": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.ProductStandard"
}
},
"status": {
"description": "Status of banner (enabled, disabled) // Child menus",
"type": "string"
},
"target": {
"type": "string"
},
"title": {
"description": "Display name of banner",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
}
}
},
"schema.ProductCategory": {
"type": "object",
"properties": {
"created_at": {
"description": "Create time",
"type": "string"
},
"id": {
"type": "integer"
},
"label": {
"description": "Display name of banner",
"type": "string"
},
"parentID": {
"description": "Type of banner (banner, link) // Parent menu` + "`" + `` + "`" + `",
"type": "integer"
},
"status": {
"description": "Status of banner (enabled, disabled) // Child menus",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
}
}
},
"schema.ProductForm": {
"type": "object",
"required": [
"categoryID",
"status",
"title"
],
"properties": {
"categoryID": {
"type": "integer",
"maximum": 11
},
"code": {
"type": "string"
},
"compose": {
"type": "string"
},
"feature": {
"type": "string"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"standard": {
"description": "Details about banner",
"type": "array",
"items": {
"$ref": "#/definitions/schema.ProductStandard"
}
},
"status": {
"type": "string",
"enum": [
"disabled",
"enabled"
]
},
"target": {
"description": "Type of menu (banner, link) // Parent menu` + "`" + `` + "`" + `",
"type": "string"
},
"title": {
"description": "Display name of menu",
"type": "string",
"maxLength": 128
}
}
},
"schema.ProductStandard": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"schema.Role": {
"type": "object",
"properties": {
"code": {
"description": "Code of role (unique)",
"type": "string"
},
"created_at": {
"description": "Create time",
"type": "string"
},
"description": {
"description": "Details about role",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"menus": {
"description": "Role menu list",
"type": "array",
"items": {
"$ref": "#/definitions/schema.RoleMenu"
}
},
"name": {
"description": "Display name of role",
"type": "string"
},
"sequence": {
"description": "Sequence for sorting",
"type": "integer"
},
"status": {
"description": "Status of role (disabled, enabled)",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
}
}
},
"schema.RoleForm": {
"type": "object",
"required": [
"code",
"name",
"status"
],
"properties": {
"code": {
"description": "Code of role (unique)",
"type": "string",
"maxLength": 32
},
"description": {
"description": "Details about role",
"type": "string"
},
"menus": {
"description": "Role menu list",
"type": "array",
"items": {
"$ref": "#/definitions/schema.RoleMenu"
}
},
"name": {
"description": "Display name of role",
"type": "string",
"maxLength": 128
},
"sequence": {
"description": "Sequence for sorting",
"type": "integer"
},
"status": {
"description": "Status of role (enabled, disabled)",
"type": "string",
"enum": [
"disabled",
"enabled"
]
}
}
},
"schema.RoleMenu": {
"type": "object",
"properties": {
"created_at": {
"description": "Create time",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"menu_id": {
"description": "From Menu.ID",
"type": "string"
},
"role_id": {
"description": "From Role.ID",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
}
}
},
"schema.SocialMedia": {
"type": "object",
"properties": {
"image": {
"type": "string"
},
"link": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"schema.Team": {
"type": "object",
"properties": {
"area": {
"type": "string"
},
"created_at": {
"description": "Create time",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"img": {
"description": "Details about banner",
"type": "string"
},
"name": {
"description": "Display name of banner",
"type": "string"
},
"rank": {
"description": "Type of banner (banner, link) // Parent menu` + "`" + `` + "`" + `",
"type": "array",
"items": {
"type": "string"
}
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"status": {
"description": "Status of banner (enabled, disabled) // Child menus",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
}
}
},
"schema.TeamForm": {
"type": "object",
"required": [
"name",
"status"
],
"properties": {
"area": {
"type": "string"
},
"img": {
"description": "Details about banner",
"type": "string"
},
"name": {
"description": "Display name of menu",
"type": "string",
"maxLength": 128
},
"rank": {
"description": "Type of banner (ban",
"type": "array",
"items": {
"type": "string"
}
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"status": {
"description": "Status of menu (enabled, disabled)",
"type": "string",
"enum": [
"disabled",
"enabled"
]
}
}
},
"schema.UpdateCurrentUser": {
"type": "object",
"required": [
"name"
],
"properties": {
"email": {
"description": "Email of user",
"type": "string",
"maxLength": 128
},
"name": {
"description": "Name of user",
"type": "string",
"maxLength": 64
},
"phone": {
"description": "Phone number of user",
"type": "string",
"maxLength": 32
},
"remark": {
"description": "Remark of user",
"type": "string",
"maxLength": 1024
}
}
},
"schema.UpdateLoginPassword": {
"type": "object",
"required": [
"new_password",
"old_password"
],
"properties": {
"new_password": {
"description": "New password (md5 hash)",
"type": "string"
},
"old_password": {
"description": "Old password (md5 hash)",
"type": "string"
}
}
},
"schema.User": {
"type": "object",
"properties": {
"created_at": {
"description": "Create time",
"type": "string"
},
"email": {
"description": "Email of user",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"name": {
"description": "Name of user",
"type": "string"
},
"phone": {
"description": "Phone number of user",
"type": "string"
},
"remark": {
"description": "Remark of user",
"type": "string"
},
"roles": {
"description": "Roles of user",
"type": "array",
"items": {
"$ref": "#/definitions/schema.UserRole"
}
},
"status": {
"description": "Status of user (activated, freezed)",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
},
"username": {
"description": "Username for login",
"type": "string"
}
}
},
"schema.UserForm": {
"type": "object",
"required": [
"name",
"roles",
"status",
"username"
],
"properties": {
"email": {
"description": "Email of user",
"type": "string",
"maxLength": 128
},
"name": {
"description": "Name of user",
"type": "string",
"maxLength": 64
},
"password": {
"description": "Password for login (md5 hash)",
"type": "string",
"maxLength": 64
},
"phone": {
"description": "Phone number of user",
"type": "string",
"maxLength": 32
},
"remark": {
"description": "Remark of user",
"type": "string",
"maxLength": 1024
},
"roles": {
"description": "Roles of user",
"type": "array",
"items": {
"$ref": "#/definitions/schema.UserRole"
}
},
"status": {
"description": "Status of user (activated, freezed)",
"type": "string",
"enum": [
"activated",
"freezed"
]
},
"username": {
"description": "Username for login",
"type": "string",
"maxLength": 64
}
}
},
"schema.UserRole": {
"type": "object",
"properties": {
"created_at": {
"description": "Create time",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"role_id": {
"description": "From Role.ID",
"type": "string"
},
"role_name": {
"description": "From Role.Name",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
},
"user_id": {
"description": "From User.ID",
"type": "string"
}
}
},
"schema.Video": {
"type": "object",
"properties": {
"created_at": {
"description": "Create time",
"type": "string"
},
"fullImg": {
"description": "Details about banner",
"type": "string"
},
"id": {
"description": "Unique ID",
"type": "string"
},
"link": {
"type": "string"
},
"pushAt": {
"type": "string"
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"smallImg": {
"type": "string"
},
"status": {
"description": "Status of banner (enabled, disabled) // Child menus",
"type": "string"
},
"subheading": {
"description": "Display name of banner",
"type": "string"
},
"title": {
"description": "Display name of banner",
"type": "string"
},
"updated_at": {
"description": "Update time",
"type": "string"
},
"videoUrl": {
"type": "string"
}
}
},
"schema.VideoForm": {
"type": "object",
"required": [
"status",
"title"
],
"properties": {
"fullImg": {
"type": "string"
},
"link": {
"type": "string"
},
"pushAt": {
"type": "string"
},
"sequence": {
"description": "Sequence for sorting (Order by desc)",
"type": "integer"
},
"smallImg": {
"type": "string"
},
"status": {
"description": "Status of menu (enabled, disabled)",
"type": "string",
"enum": [
"disabled",
"enabled"
]
},
"title": {
"description": "Display name of menu",
"type": "string",
"maxLength": 128
},
"videoUrl": {
"type": "string"
}
}
},
"schema.WebJobData": {
"type": "object",
"properties": {
"jobAreaTitle": {
"type": "string"
},
"jobList": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.Job"
}
}
}
},
"schema.WebSite": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"affirm": {
"type": "string"
},
"created_at": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "string"
},
"lat": {
"type": "number"
},
"lon": {
"type": "number"
},
"phone": {
"type": "string"
},
"reportContent": {
"type": "string"
},
"reportImage": {
"type": "string"
},
"reportNum": {
"type": "string"
},
"socialMedia": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.SocialMedia"
}
},
"updated_at": {
"type": "string"
}
}
},
"schema.WebSiteForm": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"affirm": {
"type": "string"
},
"email": {
"type": "string"
},
"lat": {
"type": "number"
},
"lon": {
"type": "number"
},
"phone": {
"type": "string"
},
"reportContent": {
"type": "string"
},
"reportImage": {
"type": "string"
},
"reportNum": {
"type": "string"
},
"socialMedia": {
"type": "array",
"items": {
"$ref": "#/definitions/schema.SocialMedia"
}
}
}
},
"util.ResponseResult": {
"type": "object",
"properties": {
"data": {},
"error": {
"$ref": "#/definitions/errors.Error"
},
"success": {
"type": "boolean"
},
"total": {
"type": "integer"
}
}
}
},
"securityDefinitions": {
"ApiKeyAuth": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "v1.0.0",
Host: "",
BasePath: "",
Schemes: []string{},
Title: "hailinservice",
Description: "Hailinservice API service",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",
RightDelim: "}}",
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}
Reference in New Issue View Git Blame Copy Permalink