learnsteam/learnsteam-quiz-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Swag Tags

Browse Source
This commit is contained in:
JongYeob Sheen
2023-11-17 14:27:42 +09:00
parent 5b5870f354
commit 7efa198a3f
23 changed files with 281 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
docs/docs.go
View File

@@ -27,6 +27,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"로그인"
],
"summary": "로그인",
"parameters": [
{
@@ -67,6 +70,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"회원가입"
],
"summary": "회원가입",
"parameters": [
{
@@ -109,11 +115,6 @@ const docTemplate = `{
},
"/program": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "퀴즈 프로그램 목록을 가져옵니다.",
"consumes": [
"application/json"
@@ -121,6 +122,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"Program"
],
"summary": "프로그램 목록 가져오기",
"parameters": [
{
@@ -165,6 +169,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"Program"
],
"summary": "퀴즈 프로그램 수정",
"parameters": [
{
@@ -242,6 +249,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"Program"
],
"summary": "퀴즈 프로그램 생성",
"parameters": [
{
@@ -321,6 +331,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"Program"
],
"summary": "퀴즈 프로그램 가져오기",
"parameters": [
{
@@ -337,9 +350,6 @@ const docTemplate = `{
"schema": {
"$ref": "#/definitions/learnsteam_learsteam-quiz-api_internal_models.ProgramResponse"
}
},
"400": {
"description": "Bad Request"
}
}
}
@@ -353,6 +363,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"Quiz"
],
"summary": "퀴즈 목록 가져오기",
"parameters": [
{
@@ -398,6 +411,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"Quiz"
],
"summary": "퀴즈 수정",
"parameters": [
{
@@ -503,6 +519,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"Quiz"
],
"summary": "퀴즈 생성",
"parameters": [
{
@@ -603,6 +622,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"Quiz"
],
"summary": "퀴즈 가져오기",
"parameters": [
{
@@ -619,9 +641,6 @@ const docTemplate = `{
"schema": {
"$ref": "#/definitions/learnsteam_learsteam-quiz-api_internal_models.QuizResponse"
}
},
"400": {
"description": "Bad Request"
}
}
}
@@ -635,6 +654,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"Token"
],
"summary": "AccessToken Refresh",
"parameters": [
{
@@ -666,6 +688,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "사용자 목록 가져오기",
"parameters": [
{
@@ -706,6 +731,9 @@ const docTemplate = `{
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "사용자 정보 가져오기",
"parameters": [
{
@@ -722,9 +750,6 @@ const docTemplate = `{
"schema": {
"$ref": "#/definitions/learnsteam_learsteam-quiz-api_internal_models.User"
}
},
"400": {
"description": "Bad Request"
}
}
}

53
docs/swagger.json
View File

@@ -19,6 +19,9 @@
"produces": [
"application/json"
],
"tags": [
"로그인"
],
"summary": "로그인",
"parameters": [
{
@@ -59,6 +62,9 @@
"produces": [
"application/json"
],
"tags": [
"회원가입"
],
"summary": "회원가입",
"parameters": [
{
@@ -101,11 +107,6 @@
},
"/program": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "퀴즈 프로그램 목록을 가져옵니다.",
"consumes": [
"application/json"
@@ -113,6 +114,9 @@
"produces": [
"application/json"
],
"tags": [
"Program"
],
"summary": "프로그램 목록 가져오기",
"parameters": [
{
@@ -157,6 +161,9 @@
"produces": [
"application/json"
],
"tags": [
"Program"
],
"summary": "퀴즈 프로그램 수정",
"parameters": [
{
@@ -234,6 +241,9 @@
"produces": [
"application/json"
],
"tags": [
"Program"
],
"summary": "퀴즈 프로그램 생성",
"parameters": [
{
@@ -313,6 +323,9 @@
"produces": [
"application/json"
],
"tags": [
"Program"
],
"summary": "퀴즈 프로그램 가져오기",
"parameters": [
{
@@ -329,9 +342,6 @@
"schema": {
"$ref": "#/definitions/learnsteam_learsteam-quiz-api_internal_models.ProgramResponse"
}
},
"400": {
"description": "Bad Request"
}
}
}
@@ -345,6 +355,9 @@
"produces": [
"application/json"
],
"tags": [
"Quiz"
],
"summary": "퀴즈 목록 가져오기",
"parameters": [
{
@@ -390,6 +403,9 @@
"produces": [
"application/json"
],
"tags": [
"Quiz"
],
"summary": "퀴즈 수정",
"parameters": [
{
@@ -495,6 +511,9 @@
"produces": [
"application/json"
],
"tags": [
"Quiz"
],
"summary": "퀴즈 생성",
"parameters": [
{
@@ -595,6 +614,9 @@
"produces": [
"application/json"
],
"tags": [
"Quiz"
],
"summary": "퀴즈 가져오기",
"parameters": [
{
@@ -611,9 +633,6 @@
"schema": {
"$ref": "#/definitions/learnsteam_learsteam-quiz-api_internal_models.QuizResponse"
}
},
"400": {
"description": "Bad Request"
}
}
}
@@ -627,6 +646,9 @@
"produces": [
"application/json"
],
"tags": [
"Token"
],
"summary": "AccessToken Refresh",
"parameters": [
{
@@ -658,6 +680,9 @@
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "사용자 목록 가져오기",
"parameters": [
{
@@ -698,6 +723,9 @@
"produces": [
"application/json"
],
"tags": [
"User"
],
"summary": "사용자 정보 가져오기",
"parameters": [
{
@@ -714,9 +742,6 @@
"schema": {
"$ref": "#/definitions/learnsteam_learsteam-quiz-api_internal_models.User"
}
},
"400": {
"description": "Bad Request"
}
}
}

34
docs/swagger.yaml
View File

@@ -244,6 +244,8 @@ paths:
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.LoginResponse'
summary: 로그인
tags:
- 로그인
/auth/register:
post:
consumes:
@@ -276,6 +278,8 @@ paths:
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.RegisterResponse'
summary: 회원가입
tags:
- 회원가입
/program:
get:
consumes:
@@ -305,9 +309,9 @@ paths:
description: OK
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.ProgramListResponse'
security:
- ApiKeyAuth: []
summary: 프로그램 목록 가져오기
tags:
- Program
post:
consumes:
- application/json
@@ -359,6 +363,8 @@ paths:
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.ProgramResponse'
summary: 퀴즈 프로그램 생성
tags:
- Program
put:
consumes:
- application/json
@@ -410,6 +416,8 @@ paths:
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.ProgramResponse'
summary: 퀴즈 프로그램 수정
tags:
- Program
/program/{id}:
get:
consumes:
@@ -428,9 +436,9 @@ paths:
description: OK
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.ProgramResponse'
"400":
description: Bad Request
summary: 퀴즈 프로그램 가져오기
tags:
- Program
/quiz:
get:
consumes:
@@ -462,6 +470,8 @@ paths:
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.QuizListResponse'
summary: 퀴즈 목록 가져오기
tags:
- Quiz
post:
consumes:
- application/json
@@ -527,6 +537,8 @@ paths:
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.QuizResponse'
summary: 퀴즈 생성
tags:
- Quiz
put:
consumes:
- application/json
@@ -597,6 +609,8 @@ paths:
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.QuizResponse'
summary: 퀴즈 수정
tags:
- Quiz
/quiz/{id}:
get:
consumes:
@@ -615,9 +629,9 @@ paths:
description: OK
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.QuizResponse'
"400":
description: Bad Request
summary: 퀴즈 가져오기
tags:
- Quiz
/token/refresh:
post:
consumes:
@@ -638,6 +652,8 @@ paths:
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.ProgramResponse'
summary: AccessToken Refresh
tags:
- Token
/user:
get:
consumes:
@@ -664,6 +680,8 @@ paths:
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.UserListResponse'
summary: 사용자 목록 가져오기
tags:
- User
/user/{id}:
get:
consumes:
@@ -682,7 +700,7 @@ paths:
description: OK
schema:
$ref: '#/definitions/learnsteam_learsteam-quiz-api_internal_models.User'
"400":
description: Bad Request
summary: 사용자 정보 가져오기
tags:
- User
swagger: "2.0"