Skip to content
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

Ignore: πŸ”§ Swagger μ—λŸ¬ μ •μ˜ μ–΄λ…Έν…Œμ΄μ…˜ #150

Merged
merged 9 commits into from
Aug 13, 2024
Merged

Ignore: πŸ”§ Swagger μ—λŸ¬ μ •μ˜ μ–΄λ…Έν…Œμ΄μ…˜ #150

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7b7f35e
feat: api_exception_explain μ–΄λ…Έν…Œμ΄μ…˜ μ •μ˜
psychology50 Aug 13, 2024
a395f48
fix: μ—λŸ¬ μ„€λͺ…을 μœ„ν•œ ν•„λ“œ μΆ”κ°€
psychology50 Aug 13, 2024
49f3030
feat: 볡수개의 error responseλ₯Ό λ‹΄κΈ° μœ„ν•œ 쀑간 μ–΄λ…Έν…Œμ΄μ…˜
psychology50 Aug 13, 2024
ccda74a
feat: μ—λŸ¬ 응닡 νŒŒμ„œ κ΅¬ν˜„
psychology50 Aug 13, 2024
56b33f0
chore: swagger config에 νŒŒμ„œ 빈 등둝
psychology50 Aug 13, 2024
9d0d680
rename: explanation μ˜€νƒ€ μˆ˜μ •
psychology50 Aug 13, 2024
125c96e
fix: enum μƒμˆ˜ 좔둠을 μœ„ν•œ field μΆ”κ°€ 및 νŒŒμ„œ 둜직 μˆ˜μ •
psychology50 Aug 13, 2024
9b83ee5
docs: μ§€μΆœ λ‚΄μ—­ 상세 쑰회 μ˜ˆμ™Έμ— api_response_explanations 적용
psychology50 Aug 13, 2024
af63115
chore: swagger config grouped_open_api add_operation_customizer 적용
psychology50 Aug 13, 2024
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
Prev Previous commit
Next Next commit
rename: explanation μ˜€νƒ€ μˆ˜μ •
  • Loading branch information
@psychology50
psychology50 committed Aug 13, 2024
commit 9d0d68084a5f9bee25226a587fff1247dc97b8c6
2 changes: 1 addition & 1 deletion ...ommon/annotation/ApiExceptionExplain.java β†’ ...n/annotation/ApiExceptionExplanation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiExceptionExplain {
public @interface ApiExceptionExplanation {
Class<? extends BaseErrorCode> value();

String name() default "";
Expand Down
4 changes: 2 additions & 2 deletions .../annotation/ApiResponseExplainations.java β†’ ...n/annotation/ApiResponseExplanations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiResponseExplainations {
ApiExceptionExplain[] errors() default {};
public @interface ApiResponseExplanations {
ApiExceptionExplanation[] errors() default {};
}
10 changes: 5 additions & 5 deletions ...ternal-api/src/main/java/kr/co/pennyway/api/common/swagger/ApiExceptionExplainParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
import io.swagger.v3.oas.models.media.MediaType;
import io.swagger.v3.oas.models.responses.ApiResponse;
import io.swagger.v3.oas.models.responses.ApiResponses;
import kr.co.pennyway.api.common.annotation.ApiExceptionExplain;
import kr.co.pennyway.api.common.annotation.ApiResponseExplainations;
import kr.co.pennyway.api.common.annotation.ApiExceptionExplanation;
import kr.co.pennyway.api.common.annotation.ApiResponseExplanations;
import kr.co.pennyway.api.common.response.ErrorResponse;
import kr.co.pennyway.common.exception.BaseErrorCode;
import lombok.AccessLevel;
Expand All @@ -22,14 +22,14 @@

public final class ApiExceptionExplainParser {
public static void parse(Operation operation, HandlerMethod handlerMethod) {
ApiResponseExplainations annotation = handlerMethod.getMethodAnnotation(ApiResponseExplainations.class);
ApiResponseExplanations annotation = handlerMethod.getMethodAnnotation(ApiResponseExplanations.class);

if (annotation != null) {
generateExceptionResponseDocs(operation, annotation.errors());
}
}

private static void generateExceptionResponseDocs(Operation operation, ApiExceptionExplain[] exceptions) {
private static void generateExceptionResponseDocs(Operation operation, ApiExceptionExplanation[] exceptions) {
ApiResponses responses = operation.getResponses();

Map<Integer, List<ExampleHolder>> holders = Arrays.stream(exceptions)
Expand All @@ -55,7 +55,7 @@ private static void addExamplesToResponses(ApiResponses responses, Map<Integer,

@Builder(access = AccessLevel.PRIVATE)
private record ExampleHolder(int httpStatus, String name, String mediaType, String description, Example holder) {
static ExampleHolder from(ApiExceptionExplain annotation) {
static ExampleHolder from(ApiExceptionExplanation annotation) {
if (annotation instanceof BaseErrorCode errorCode) {
return ExampleHolder.builder()
.httpStatus(errorCode.causedBy().statusCode().getCode())
Expand Down