nixcn/cms-server
1
0
Fork 1
Code Pull Requests Activity

Fix swagger data struct error
Some checks failed
Backend Check Build (NixCN CMS) TeamCity build failed
Details
Client CMS Check Build (NixCN CMS) TeamCity build finished
Details

Browse Source 
Signed-off-by: Asai Neko <sugar@sne.moe>
This commit is contained in:
Asai Neko
2026-01-29 01:25:12 +08:00
parent f7bde8ef2e
commit 654b196bfd
15 changed files with 136 additions and 316 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
api/auth/exchange.go
View File

@@ -16,7 +16,7 @@ import (
// @Accept json
// @Produce json
// @Param payload body service_auth.ExchangeData true "Exchange Request Credentials"
// @Success 200 {object} utils.RespStatus{data=service_auth.ExchangeResult} "Successful exchange"
// @Success 200 {object} utils.RespStatus{data=service_auth.ExchangeResponse} "Successful exchange"
// @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input"
// @Failure 401 {object} utils.RespStatus{data=nil} "Unauthorized"
// @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error"

2
api/auth/magic.go
View File

@@ -15,7 +15,7 @@ import (
// @Accept json
// @Produce json
// @Param payload body service_auth.MagicData true "Magic Link Request Data"
// @Success 200 {object} utils.RespStatus{data=service_auth.MagicResult} "Successful request"
// @Success 200 {object} utils.RespStatus{data=service_auth.MagicResponse} "Successful request"
// @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input"
// @Failure 403 {object} utils.RespStatus{data=nil} "Turnstile Verification Failed"
// @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error"

4
api/event/checkin.go
View File

@@ -16,7 +16,7 @@ import (
// @Accept json
// @Produce json
// @Param event_id query string true "Event UUID"
// @Success 200 {object} utils.RespStatus{data=service_event.CheckinResult} "Successfully generated code"
// @Success 200 {object} utils.RespStatus{data=service_event.CheckinResponse} "Successfully generated code"
// @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input"
// @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error"
// @Router /event/checkin [get]
@@ -86,7 +86,7 @@ func (self *EventHandler) CheckinSubmit(c *gin.Context) {
// @Accept json
// @Produce json
// @Param event_id query string true "Event UUID"
// @Success 200 {object} utils.RespStatus{data=service_event.CheckinQueryResult} "Current attendance status"
// @Success 200 {object} utils.RespStatus{data=service_event.CheckinQueryResponse} "Current attendance status"
// @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input"
// @Failure 404 {object} utils.RespStatus{data=nil} "Record Not Found"
// @Router /event/checkin/query [get]

2
api/event/info.go
View File

@@ -16,7 +16,7 @@ import (
// @Accept json
// @Produce json
// @Param event_id query string true "Event UUID"
// @Success 200 {object} utils.RespStatus{data=service_event.InfoResult} "Successful retrieval"
// @Success 200 {object} utils.RespStatus{data=service_event.InfoResponse} "Successful retrieval"
// @Failure 400 {object} utils.RespStatus{data=nil} "Invalid Input"
// @Failure 404 {object} utils.RespStatus{data=nil} "Event Not Found"
// @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error"

2
api/user/full.go
View File

@@ -14,7 +14,7 @@ import (
// @Tags User
// @Accept json
// @Produce json
// @Success 200 {object} utils.RespStatus{data=service_user.UserTableResult} "Successful retrieval of full user table"
// @Success 200 {object} utils.RespStatus{data=service_user.UserTableResponse} "Successful retrieval of full user table"
// @Failure 500 {object} utils.RespStatus{data=nil} "Internal Server Error (Database Error)"
// @Security ApiKeyAuth
// @Router /user/full [get]

127
docs/docs.go
View File

@@ -56,7 +56,7 @@ const docTemplate = `{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.ExchangeResult"
"$ref": "#/definitions/service_auth.ExchangeResponse"
}
}
}
@@ -156,7 +156,7 @@ const docTemplate = `{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.MagicResult"
"$ref": "#/definitions/service_auth.MagicResponse"
}
}
}
@@ -561,7 +561,7 @@ const docTemplate = `{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.CheckinResult"
"$ref": "#/definitions/service_event.CheckinResponse"
}
}
}
@@ -641,7 +641,7 @@ const docTemplate = `{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.CheckinQueryResult"
"$ref": "#/definitions/service_event.CheckinQueryResponse"
}
}
}
@@ -785,7 +785,7 @@ const docTemplate = `{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.InfoResult"
"$ref": "#/definitions/service_event.InfoResponse"
}
}
}
@@ -879,7 +879,7 @@ const docTemplate = `{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_user.UserTableResult"
"$ref": "#/definitions/service_user.UserTableResponse"
}
}
}
@@ -1261,30 +1261,6 @@ const docTemplate = `{
}
}
},
"exception.Builder": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"error": {},
"errorCode": {
"type": "string"
},
"original": {
"type": "string"
},
"service": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"service_auth.ExchangeData": {
"type": "object",
"properties": {
@@ -1299,19 +1275,11 @@ const docTemplate = `{
}
}
},
"service_auth.ExchangeResult": {
"service_auth.ExchangeResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"type": "object",
"properties": {
"redirect_uri": {
"type": "string"
}
}
"redirect_uri": {
"type": "string"
}
}
},
@@ -1338,13 +1306,12 @@ const docTemplate = `{
}
}
},
"service_auth.MagicResult": {
"service_auth.MagicResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {}
"uri": {
"type": "string"
}
}
},
"service_auth.RefreshData": {
@@ -1374,35 +1341,19 @@ const docTemplate = `{
}
}
},
"service_event.CheckinQueryResult": {
"service_event.CheckinQueryResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"type": "object",
"properties": {
"checkin_at": {
"type": "string"
}
}
"checkin_at": {
"type": "string"
}
}
},
"service_event.CheckinResult": {
"service_event.CheckinResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"type": "object",
"properties": {
"checkin_code": {
"type": "string"
}
}
"checkin_code": {
"type": "string"
}
}
},
@@ -1414,25 +1365,17 @@ const docTemplate = `{
}
}
},
"service_event.InfoResult": {
"service_event.InfoResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
"end_time": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"end_time": {
"type": "string"
},
"name": {
"type": "string"
},
"start_time": {
"type": "string"
}
}
"name": {
"type": "string"
},
"start_time": {
"type": "string"
}
}
},
@@ -1468,12 +1411,9 @@ const docTemplate = `{
}
}
},
"service_user.UserTableResult": {
"service_user.UserTableResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"user_table": {
"type": "array",
"items": {
@@ -1482,17 +1422,6 @@ const docTemplate = `{
}
}
},
"shared.CommonResult": {
"type": "object",
"properties": {
"exception": {
"$ref": "#/definitions/exception.Builder"
},
"httpCode": {
"type": "integer"
}
}
},
"utils.RespStatus": {
"type": "object",
"properties": {

127
docs/swagger.json
View File

@@ -45,7 +45,7 @@
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.ExchangeResult"
"$ref": "#/definitions/service_auth.ExchangeResponse"
}
}
}
@@ -145,7 +145,7 @@
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_auth.MagicResult"
"$ref": "#/definitions/service_auth.MagicResponse"
}
}
}
@@ -550,7 +550,7 @@
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.CheckinResult"
"$ref": "#/definitions/service_event.CheckinResponse"
}
}
}
@@ -630,7 +630,7 @@
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.CheckinQueryResult"
"$ref": "#/definitions/service_event.CheckinQueryResponse"
}
}
}
@@ -774,7 +774,7 @@
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_event.InfoResult"
"$ref": "#/definitions/service_event.InfoResponse"
}
}
}
@@ -868,7 +868,7 @@
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/service_user.UserTableResult"
"$ref": "#/definitions/service_user.UserTableResponse"
}
}
}
@@ -1250,30 +1250,6 @@
}
}
},
"exception.Builder": {
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"error": {},
"errorCode": {
"type": "string"
},
"original": {
"type": "string"
},
"service": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"service_auth.ExchangeData": {
"type": "object",
"properties": {
@@ -1288,19 +1264,11 @@
}
}
},
"service_auth.ExchangeResult": {
"service_auth.ExchangeResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"type": "object",
"properties": {
"redirect_uri": {
"type": "string"
}
}
"redirect_uri": {
"type": "string"
}
}
},
@@ -1327,13 +1295,12 @@
}
}
},
"service_auth.MagicResult": {
"service_auth.MagicResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {}
"uri": {
"type": "string"
}
}
},
"service_auth.RefreshData": {
@@ -1363,35 +1330,19 @@
}
}
},
"service_event.CheckinQueryResult": {
"service_event.CheckinQueryResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"type": "object",
"properties": {
"checkin_at": {
"type": "string"
}
}
"checkin_at": {
"type": "string"
}
}
},
"service_event.CheckinResult": {
"service_event.CheckinResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"data": {
"type": "object",
"properties": {
"checkin_code": {
"type": "string"
}
}
"checkin_code": {
"type": "string"
}
}
},
@@ -1403,25 +1354,17 @@
}
}
},
"service_event.InfoResult": {
"service_event.InfoResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
"end_time": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"end_time": {
"type": "string"
},
"name": {
"type": "string"
},
"start_time": {
"type": "string"
}
}
"name": {
"type": "string"
},
"start_time": {
"type": "string"
}
}
},
@@ -1457,12 +1400,9 @@
}
}
},
"service_user.UserTableResult": {
"service_user.UserTableResponse": {
"type": "object",
"properties": {
"common": {
"$ref": "#/definitions/shared.CommonResult"
},
"user_table": {
"type": "array",
"items": {
@@ -1471,17 +1411,6 @@
}
}
},
"shared.CommonResult": {
"type": "object",
"properties": {
"exception": {
"$ref": "#/definitions/exception.Builder"
},
"httpCode": {
"type": "integer"
}
}
},
"utils.RespStatus": {
"type": "object",
"properties": {

98
docs/swagger.yaml
View File

@@ -41,22 +41,6 @@ definitions:
username:
type: string
type: object
exception.Builder:
properties:
endpoint:
type: string
error: {}
errorCode:
type: string
original:
type: string
service:
type: string
status:
type: string
type:
type: string
type: object
service_auth.ExchangeData:
properties:
client_id:
@@ -66,15 +50,10 @@ definitions:
state:
type: string
type: object
service_auth.ExchangeResult:
service_auth.ExchangeResponse:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
data:
properties:
redirect_uri:
type: string
type: object
redirect_uri:
type: string
type: object
service_auth.MagicData:
properties:
@@ -91,11 +70,10 @@ definitions:
turnstile_token:
type: string
type: object
service_auth.MagicResult:
service_auth.MagicResponse:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
data: {}
uri:
type: string
type: object
service_auth.RefreshData:
properties:
@@ -114,44 +92,29 @@ definitions:
refresh_token:
type: string
type: object
service_event.CheckinQueryResult:
service_event.CheckinQueryResponse:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
data:
properties:
checkin_at:
type: string
type: object
checkin_at:
type: string
type: object
service_event.CheckinResult:
service_event.CheckinResponse:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
data:
properties:
checkin_code:
type: string
type: object
checkin_code:
type: string
type: object
service_event.CheckinSubmitData:
properties:
checkin_code:
type: string
type: object
service_event.InfoResult:
service_event.InfoResponse:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
data:
properties:
end_time:
type: string
name:
type: string
start_time:
type: string
type: object
end_time:
type: string
name:
type: string
start_time:
type: string
type: object
service_user.UserInfoData:
properties:
@@ -174,22 +137,13 @@ definitions:
username:
type: string
type: object
service_user.UserTableResult:
service_user.UserTableResponse:
properties:
common:
$ref: '#/definitions/shared.CommonResult'
user_table:
items:
$ref: '#/definitions/data.User'
type: array
type: object
shared.CommonResult:
properties:
exception:
$ref: '#/definitions/exception.Builder'
httpCode:
type: integer
type: object
utils.RespStatus:
properties:
code:
@@ -226,7 +180,7 @@ paths:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_auth.ExchangeResult'
$ref: '#/definitions/service_auth.ExchangeResponse'
type: object
"400":
description: Invalid Input
@@ -283,7 +237,7 @@ paths:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_auth.MagicResult'
$ref: '#/definitions/service_auth.MagicResponse'
type: object
"400":
description: Invalid Input
@@ -512,7 +466,7 @@ paths:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_event.CheckinResult'
$ref: '#/definitions/service_event.CheckinResponse'
type: object
"400":
description: Invalid Input
@@ -557,7 +511,7 @@ paths:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_event.CheckinQueryResult'
$ref: '#/definitions/service_event.CheckinQueryResponse'
type: object
"400":
description: Invalid Input
@@ -638,7 +592,7 @@ paths:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_event.InfoResult'
$ref: '#/definitions/service_event.InfoResponse'
type: object
"400":
description: Invalid Input
@@ -686,7 +640,7 @@ paths:
- $ref: '#/definitions/utils.RespStatus'
- properties:
data:
$ref: '#/definitions/service_user.UserTableResult'
$ref: '#/definitions/service_user.UserTableResponse'
type: object
"500":
description: Internal Server Error (Database Error)

2
generate.go
View File

@@ -1,3 +1,5 @@
package main
//go:generate go run ./cmd/gen_exception/main.go
//go:generate swag init

2
justfile
View File

@@ -39,7 +39,7 @@ gen-back:
cd {{ project_dir }} && go generate .
watch-back:
watchexec -r -e go,yaml,tpl -i '.devenv/**' -i '.direnv/**' -i 'client/**' -i 'vendor/**' 'swag init && go build -o {{ server_exec_path }} . && cd {{ output_dir }} && CONFIG_PATH={{ output_dir }} {{ server_exec_path }}'
watchexec -r -e go,yaml,tpl -i '.devenv/**' -i '.direnv/**' -i 'client/**' -i 'vendor/**' 'go build -o {{ server_exec_path }} . && cd {{ output_dir }} && CONFIG_PATH={{ output_dir }} {{ server_exec_path }}'
dev: clean install generate
devenv up --verbose

14
service/service_auth/exchange.go
View File

@@ -23,11 +23,13 @@ type ExchangePayload struct {
Data *ExchangeData
}
type ExchangeResponse struct {
RedirectUri string `json:"redirect_uri"`
}
type ExchangeResult struct {
Common shared.CommonResult
Data *struct {
RedirectUri string `json:"redirect_uri"`
}
Data *ExchangeResponse
}
func (self *AuthServiceImpl) Exchange(payload *ExchangePayload) (result *ExchangeResult) {
@@ -113,16 +115,14 @@ func (self *AuthServiceImpl) Exchange(payload *ExchangePayload) (result *Exchang
SetError(nil).
Throw(payload.Context)
resultData := struct {
RedirectUri string `json:"redirect_uri"`
}{url.String()}
resultData := &ExchangeResponse{url.String()}
result = &ExchangeResult{
Common: shared.CommonResult{
HttpCode: 200,
Exception: exception,
},
Data: &resultData,
Data: resultData,
}
return

8
service/service_auth/magic.go
View File

@@ -26,9 +26,13 @@ type MagicPayload struct {
Data *MagicData
}
type MagicResponse struct {
Uri string `json:"uri"`
}
type MagicResult struct {
Common shared.CommonResult
Data any
Data *MagicResponse
}
func (self *AuthServiceImpl) Magic(payload *MagicPayload) (result *MagicResult) {
@@ -129,7 +133,7 @@ func (self *AuthServiceImpl) Magic(payload *MagicPayload) (result *MagicResult)
HttpCode: 200,
Exception: exception,
},
Data: uriData,
Data: &MagicResponse{uriData.Uri},
}
return

26
service/service_event/checkin.go
View File

@@ -20,11 +20,13 @@ type CheckinPayload struct {
Data *CheckinData
}
type CheckinResponse struct {
CheckinCode *string `json:"checkin_code"`
}
type CheckinResult struct {
Common shared.CommonResult
Data *struct {
CheckinCode *string `json:"checkin_code"`
}
Data *CheckinResponse
}
func (self *EventServiceImpl) Checkin(payload *CheckinPayload) (result *CheckinResult) {
@@ -44,6 +46,7 @@ func (self *EventServiceImpl) Checkin(payload *CheckinPayload) (result *CheckinR
Throw(payload.Context),
},
}
return
}
@@ -58,10 +61,9 @@ func (self *EventServiceImpl) Checkin(payload *CheckinPayload) (result *CheckinR
SetOriginal(exception.CommonSuccess).
Throw(payload.Context),
},
Data: &struct {
CheckinCode *string `json:"checkin_code"`
}{code},
Data: &CheckinResponse{code},
}
return
}
@@ -123,11 +125,13 @@ type CheckinQueryPayload struct {
Data *CheckinQueryData
}
type CheckinQueryResponse struct {
CheckinAt *time.Time `json:"checkin_at"`
}
type CheckinQueryResult struct {
Common shared.CommonResult
Data *struct {
CheckinAt *time.Time `json:"checkin_at"`
}
Data *CheckinQueryResponse
}
func (self *EventServiceImpl) CheckinQuery(payload *CheckinQueryPayload) (result *CheckinQueryResult) {
@@ -183,9 +187,7 @@ func (self *EventServiceImpl) CheckinQuery(payload *CheckinQueryPayload) (result
SetOriginal(exception.CommonSuccess).
Throw(payload.Context),
},
Data: &struct {
CheckinAt *time.Time `json:"checkin_at"`
}{checkinAt},
Data: &CheckinQueryResponse{checkinAt},
}
return
}

28
service/service_event/info.go
View File

@@ -19,13 +19,15 @@ type InfoPayload struct {
Data *InfoData
}
type InfoResponse struct {
Name string `json:"name"`
StartTime time.Time `json:"start_time"`
EndTime time.Time `json:"end_time"`
}
type InfoResult struct {
Common shared.CommonResult
Data *struct {
Name string `json:"name"`
StartTime time.Time `json:"start_time"`
EndTime time.Time `json:"end_time"`
}
Data *InfoResponse
}
func (self *EventServiceImpl) Info(payload *InfoPayload) (result *InfoResult) {
@@ -50,16 +52,6 @@ func (self *EventServiceImpl) Info(payload *InfoPayload) (result *InfoResult) {
return
}
resultData := struct {
Name string `json:"name"`
StartTime time.Time `json:"start_time"`
EndTime time.Time `json:"end_time"`
}{
Name: event.Name,
StartTime: event.StartTime,
EndTime: event.EndTime,
}
result = &InfoResult{
Common: shared.CommonResult{
HttpCode: 200,
@@ -71,7 +63,11 @@ func (self *EventServiceImpl) Info(payload *InfoPayload) (result *InfoResult) {
SetOriginal(exception.CommonSuccess).
Throw(payload.Context),
},
Data: &resultData,
Data: &InfoResponse{
Name: event.Name,
StartTime: event.StartTime,
EndTime: event.EndTime,
},
}
return

8
service/service_user/list_user_full_table.go
View File

@@ -11,9 +11,13 @@ type UserTablePayload struct {
Context context.Context
}
type UserTableResponse struct {
UserTable *[]data.User `json:"user_table"`
}
type UserTableResult struct {
Common shared.CommonResult
Data *[]data.User `json:"user_table"`
Data *UserTableResponse
}
// ListUserFullTable
@@ -58,7 +62,7 @@ func (self *UserServiceImpl) GetUserFullTable(payload *UserTablePayload) (result
HttpCode: 200,
Exception: exception,
},
Data: userFullTable,
Data: &UserTableResponse{userFullTable},
}
return