Skip to content

[SWEP-58] 스웨거 문서 작성 #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jjiinaaa merged 6 commits into from
Feb 10, 2025
Merged

[SWEP-58] 스웨거 문서 작성 #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d1b297c
[SWEP-58] 스웨거 문서 작성
Socializedistp Feb 10, 2025
49ef4b0
Merge pull request #186 from Socializedistp/develop
Socializedistp Feb 10, 2025
f078fc6
[SWEP-58] 사진삭제 스웨거 주석 작성
Socializedistp Feb 10, 2025
fb530ae
Merge pull request #188 from Socializedistp/develop
Socializedistp Feb 10, 2025
4a60896
[SWEP-58] 스웨거 문서 변경
Socializedistp Feb 10, 2025
599218c
Merge pull request #190 from Socializedistp/develop
Socializedistp Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
299 changes: 297 additions & 2 deletions src/controllers/trust.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,91 @@ import {SearchNoResultsError,ServerError,DataValidationError} from 'src/errors.j
import {StatusCodes} from 'http-status-codes';

export const handleImageStatus = async (req: Request, res: Response, next:NextFunction): Promise<void> => {
/*
#swagger.tags = ['Trust']
#swagger.summary = '휴지통으로 이미지 이동 API'
#swagger.description = '선택한 이미지를 휴지통으로 이동시키는 API입니다.'
#swagger.requestBody = {
required: true,
content: {
"application/json": {
schema: {
type: "object",
properties: {
mediaId: {
type: "integer",
description: "특정 이미지의 mediaId"
}
},
required: ["mediaId"]
}
}
}
}
#swagger.responses[200] = {
description: "휴지통으로 이동 성공",
content: {
"application/json": {
schema: {
type: "object",
properties: {
resultType: { type: "string", example: "SUCCESS" },
error: { type: "object", nullable: true, example: null },
success: {
type: "object",
properties: {
mediaId: { type: "integer", example: 100001 },
status: { type: "integer", example: 0 }
}
}
}
}
}
}
}

#swagger.responses[500] = {
description: "잘못된 요청 (mediaId가 올바르지 않음)",
content: {
"application/json": {
schema: {
type: "object",
properties: {
resultType: { type: "string", example: "FAILURE" },
error: {
type: "object",
properties: {
reason: { type: "string", example: "mediaId가 올바르지 않습니다" }
}
},
success: { type: "object", nullable: true, example: null }
}
}
}
}
}

#swagger.responses[500] = {
description: "해당 mediaId에 대한 데이터를 찾을 수 없음",
content: {
"application/json": {
schema: {
type: "object",
properties: {
resultType: { type: "string", example: "FAILURE" },
error: {
type: "object",
properties: {
reason: { type: "string", example: "해당 mediaId에 대한 이미지가 존재하지 않습니다" }
}
},
success: { type: "object", nullable: true, example: null }
}
}
}
}
}
*/
try {
const {mediaId} = req.body;
const parsedMediaId = parseInt(mediaId);
Expand All @@ -24,7 +109,99 @@ export const handleImageStatus = async (req: Request, res: Response, next:NextFu
}
};

export const handleImageRestore = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
export const handleImageRestore = async (
req: Request,
res: Response,
next: NextFunction
): Promise<void> => {
/*
#swagger.tags = ['Trust']
#swagger.summary = '휴지통에서 이미지 복구 API'
#swagger.description = '선택한 이미지를 휴지통에서 복구하는 API입니다.'
#swagger.requestBody = {
required: true,
content: {
"application/json": {
schema: {
type: "object",
properties: {
mediaIds: {
type: "array",
items: { type: "integer" },
description: "복구할 이미지의 mediaId 리스트"
}
},
required: ["mediaIds"]
}
}
}
}

#swagger.responses[200] = {
description: "복구 성공",
content: {
"application/json": {
schema: {
type: "object",
properties: {
resultType: { type: "string", example: "SUCCESS" },
error: { type: "object", nullable: true, example: null },
success: {
type: "array",
items: {
type: "object",
properties: {
mediaId: { type: "integer", example: 10000001 },
status: { type: "integer", example: 1 }
}
}
}
}
}
}
}
}
#swagger.responses[500] = {
description: "잘못된 요청 (mediaId가 올바르지 않음)",
content: {
"application/json": {
schema: {
type: "object",
properties: {
resultType: { type: "string", example: "FAILURE" },
error: {
type: "object",
properties: {
reason: { type: "string", example: "mediaId가 올바르지 않습니다" }
}
},
success: { type: "object", nullable: true, example: null }
}
}
}
}
}
#swagger.responses[500] = {
description: "해당 mediaId에 대한 데이터를 찾을 수 없음",
content: {
"application/json": {
schema: {
type: "object",
properties: {
resultType: { type: "string", example: "FAILURE" },
error: {
type: "object",
properties: {
reason: { type: "string", example: "해당 mediaId에 대한 이미지가 존재하지 않습니다" }
}
},
success: { type: "object", nullable: true, example: null }
}
}
}
}
}
*/
try {
const {mediaIds} = req.body;
if (!Array.isArray(mediaIds)) {
Expand All @@ -44,7 +221,125 @@ export const handleImageRestore = async (req: Request, res: Response, next: Next
}
};

export const handleImageDelete = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
export const handleImageDelete = async (
req: Request,
res: Response,
next: NextFunction
): Promise<void> => {
/*
#swagger.tags = ['Trust']
#swagger.summary = '휴지통에서 이미지 삭제 API'
#swagger.description = '선택한 이미지를 휴지통에서 삭제하는 API입니다.'

#swagger.requestBody = {
required: true,
content: {
"application/json": {
schema: {
type: "object",
properties: {
imageIds: {
type: "array",
items: { type: "integer" },
description: "삭제할 이미지의 imageId 리스트"
}
},
required: ["imageIds"]
}
}
}
}
#swagger.responses[200] = {
description: "삭제 성공",
content: {
"application/json": {
schema: {
type: "object",
properties: {
resultType: { type: "string", example: "SUCCESS" },
error: { type: "object", nullable: true, example: null },
success: {
type: "object",
properties: {
success: { type: "boolean", example: true },
}
}
}
}
}
}
}
#swagger.responses[404] = {
description: "잘못된 요청 (imageIds가 올바르지 않음)",
content: {
"application/json": {
schema: {
type: "object",
properties: {
resultType: { type: "string", example: "FAILURE" },
error: {
type: "object",
properties: {
errorCode: { type: "string", example: "SRH-404" },
reason: { type: "string", example: "imageIds가 올바르지 않습니다" },
}
},
success: { type: "object", nullable: true, example: null }
}
},
examples: {
"유효하지 않은 imageIds": {
summary: "유효하지 않은 imageIds",
description: "전송된 imageIds 값이 배열이 아니거나 올바른 숫자가 아닐 때 발생합니다.",
value: {
resultType: "FAILURE",
error: {
errorCode: "SRH-404",
reason: "imageIds가 올바르지 않습니다", },
success: null
}
}
}
}
}
}

#swagger.responses[400] = {
description: "삭제할 이미지가 존재하지 않음",
content: {
"application/json": {
schema: {
type: "object",
properties: {
resultType: { type: "string", example: "FAILURE" },
error: {
type: "object",
properties: {
errorCode: { type: "string", example: "SRH-400" },
reason: { type: "string", example: "해당 사진이 휴지통에 존재하지 않습니다" }, }
},
success: { type: "object", nullable: true, example: null }
}
},
examples: {
"삭제할 이미지가 존재하지 않음": {
summary: "삭제할 이미지가 존재하지 않음",
description: "전달된 imageIds 중 일부 또는 전체가 존재하지 않는 경우 발생합니다.",
value: {
resultType: "FAILURE",
error: {
errorCode: "SRH-400",
reason: "해당 사진이 휴지통에 존재하지 않습니다",
},
success: null
}
}
}
}
}
}
*/

try {
const { mediaIds } = req.body;
if (!Array.isArray(mediaIds)) {
Expand Down
Loading