Skip to content

[#55] Docs: 스웨거 명세서 작성 #56

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
sehyeo merged 2 commits into from
May 15, 2025
Merged

[#55] Docs: 스웨거 명세서 작성 #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34cc834
Merge pull request #54 from parentsgowork/refactor/#52
sehyeo May 15, 2025
96c7def
[#55] Docs: 명세서 작성
sehyeo May 15, 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
3 changes: 3 additions & 0 deletions ...ava/com/parentsgowork/server/web/controller/specification/EducationInfoSpecification.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ public interface EducationInfoSpecification {
@Operation(summary = "내가 저장한 교육정보 리스트 조회", description = "내가 저장한 교육정보 리스트를 조회합니다.")
@ApiResponses({
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200", description = "⭕ SUCCESS, 성공"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "BOOKMARK4001", description = "❌ 교육정보가 존재하지 않습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON400", description = "❌ BAD, 잘못된 요청", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
})
ApiResponse<List<EducationInfoResponseDTO.EducationInfoListDTO>> getEducationInfoList();
Expand All @@ -24,6 +25,7 @@ public interface EducationInfoSpecification {
@Operation(summary = "특정 교육정보 조회", description = "내가 저장한 특정 교육정보를 조회합니다. 교육정보 아이디 값을 보내주세요.")
@ApiResponses({
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200", description = "⭕ SUCCESS, 성공"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "BOOKMARK4001", description = "❌ 교육정보가 존재하지 않습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON400", description = "❌ BAD, 잘못된 요청", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
})
ApiResponse<EducationInfoResponseDTO.EducationInfoDetailDTO> getEducationInfoDetails(@PathVariable Long educationInfoId);
Expand All @@ -32,6 +34,7 @@ public interface EducationInfoSpecification {
@Operation(summary = "내가 저장한 교육정보 삭제", description = "내가 저장한 특정 교육정보를 삭제합니다.")
@ApiResponses({
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200", description = "⭕ SUCCESS, 성공"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "BOOKMARK4001", description = "❌ 교육정보가 존재하지 않습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON400", description = "❌ BAD, 잘못된 요청", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
})
ApiResponse<EducationInfoResponseDTO.DeleteEducationInfoDTO> deleteEducationInfo(@PathVariable("educationInfoId") Long educationInfoId);
Expand Down
3 changes: 3 additions & 0 deletions ...main/java/com/parentsgowork/server/web/controller/specification/JobInfoSpecification.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public interface JobInfoSpecification {
@Operation(summary = "내가 저장한 구직정보 리스트 조회", description = "내가 저장한 구직정보 리스트를 조회합니다.")
@ApiResponses({
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200", description = "⭕ SUCCESS, 성공"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "BOOKMARK4003", description = "❌ 구직정보가 존재하지 않습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON400", description = "❌ BAD, 잘못된 요청", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
})
ApiResponse<List<JobInfoResponseDTO.JobInfoListDTO>> getJobInfoList();
Expand All @@ -46,6 +47,7 @@ public interface JobInfoSpecification {
@Operation(summary = "특정 구직정보 조회", description = "내가 저장한 특정 구직정보를 조회합니다. 구직정보 아이디 값을 보내주세요.")
@ApiResponses({
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200", description = "⭕ SUCCESS, 성공"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "BOOKMARK4003", description = "❌ 구직정보가 존재하지 않습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON400", description = "❌ BAD, 잘못된 요청", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
})
ApiResponse<JobInfoResponseDTO.JobInfoDetailDTO> getJobInfoDetails(@PathVariable Long jobInfoId);
Expand All @@ -54,6 +56,7 @@ public interface JobInfoSpecification {
@Operation(summary = "내가 저장한 구직정보 삭제", description = "내가 저장한 특정 구직정보를 삭제합니다.")
@ApiResponses({
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200", description = "⭕ SUCCESS, 성공"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "BOOKMARK4003", description = "❌ 구직정보가 존재하지 않습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON400", description = "❌ BAD, 잘못된 요청", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
})
ApiResponse<JobInfoResponseDTO.DeleteJobInfoDTO> deleteJobInfo(@PathVariable("jobInfoId") Long jobInfoId);
Expand Down
3 changes: 3 additions & 0 deletions ...n/java/com/parentsgowork/server/web/controller/specification/PolicyInfoSpecification.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ public interface PolicyInfoSpecification {
@Operation(summary = "내가 저장한 고용 정책/복지 리스트 조회", description = "내가 저장한 고용 정책/복지 리스트를 조회합니다.")
@ApiResponses({
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200", description = "⭕ SUCCESS, 성공"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "BOOKMARK4002", description = "❌ 고용 정책/복지 정보가 존재하지 않습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON400", description = "❌ BAD, 잘못된 요청", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
})
ApiResponse<List<PolicyInfoResponseDTO.PolicyInfoListDTO>> getPolicyInfoList();
Expand All @@ -26,6 +27,7 @@ public interface PolicyInfoSpecification {
@Operation(summary = "특정 고용 정책/복지 조회", description = "내가 저장한 특정 고용 정책/복지를 조회합니다. 고용 정책/복지 아이디 값을 보내주세요.")
@ApiResponses({
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200", description = "⭕ SUCCESS, 성공"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "BOOKMARK4002", description = "❌ 고용 정책/복지 정보가 존재하지 않습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON400", description = "❌ BAD, 잘못된 요청", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
})
ApiResponse<PolicyInfoResponseDTO.PolicyInfoDetailDTO> getPolicyInfoDetails(@PathVariable Long policyInfoId);
Expand All @@ -34,6 +36,7 @@ public interface PolicyInfoSpecification {
@Operation(summary = "내가 저장한 고용 정책/복지 삭제", description = "내가 저장한 특정 고용 정책/복지를 삭제합니다.")
@ApiResponses({
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200", description = "⭕ SUCCESS, 성공"),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "BOOKMARK4002", description = "❌ 고용 정책/복지 정보가 존재하지 않습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
@io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON400", description = "❌ BAD, 잘못된 요청", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
})
ApiResponse<PolicyInfoResponseDTO.DeletePolicyInfoDTO> deletePolicyInfo(@PathVariable("policyInfoId") Long policyInfoId);
Expand Down