SWAGGER4 Swagger UI Hangs on Big Json Respones 해결 방법 Swagger UI에서 많은 양의 응답 값을 받게 되면 버벅 거리는 문제 발생*자세한 설명 생략 ▷ 요약 문제 : Swagger UI syntaxHighlight로 인한 Big Json Response 처리 시간문제 해결 : application.properties에 springdoc.swagger-ui.syntaxHighlight.activated= false 추가 ▷ 해결 방법*application.properties에서 Swagger UI SyntaxHighlight 기능off # Swagger# Swagger UI syntaxHighlight Settingspringdoc.swagger-ui.syntaxHighlight.activated= false ▷ 결과 화면*SyntaxHighlight.. 2023. 10. 18. Swagger3 JWT 인증 설정 Swagger UI에서 API 테스트 시 JWT 인증을 위한 추가 설정*이전 글에 이어서 작업(관련 글 참고)*자세한 설명 생략 ▷ Swagger-ui 추가 설정 *@SecurityScheme 사용 속성태그속성설명@SecurityScheme 인증 스키마 정보를 설정type인증타입 (APIKEY, HTTP, OPENIDCONNECT, OAUTH2)in인증키 입력 위치(HEADER, QUERY, COOKIE)name인증 스키마 명description인증 스키마 설명 *@OpenAPIDefinition 사용 속성태그속성설명@SecurityRequirementnameSwagger-ui에서 사용할 인증 스키마 /** * Swagger3 * */@OpenAPIDefinition( info = @Inf.. 2023. 10. 18. Swagger 연동 및 설정 방법 Spring Boot + Swagger 연동 방법과 간단한 설정 방법*maven project에서 springdoc(swagger3)으로 진행*자세한 설명 생략 ▷ Swagger3 연동*dependency 이후 바로 사용 가능 ① pom.xml springdoc dependency org.springdoc springdoc-openapi-ui 1.7.0 ▷ Swagger3 명세서 작성 방법 *Swagger3 주요 Annotation태그속성설명@Tag Controller 명세nameAPI 그룹 명descriptionAPI 그룹 설명@Operation API 명세summaryAPI 설명descriptionAPI 상세 설명@Schema Model 명세descriptionModel 설명def.. 2023. 10. 18. Swagger 란? 시간 소요가 많고 관리하기 번거롭던 API 명세서 작성 작업을 Swagger를 통해 간단하게 해결*자세한 설명 생략 ▷ Swagger 란?*OAS : Open API Specification API의 명세(Spec)를 문서화하여 관리하기 위한 프로젝트API의 명세(Spec) 수정 시 문서 자동 갱신Spring / Spring Boot Project에서 사용 가능대표적인 라이브러리 : Springdoc, Springfox*차이점이 있고 Springdoc 선호 ▷ Swagger 특징 Annotation을 통해 API를 빠르게 명세Swagger-UI를 통해 API를 시각화한 화면 제공Swagger-UI를 통해 API 테스트 진행 가능 ▷ Swagger 사용 이유 엑셀로 관리하던 인터페이스 설계서를 Swa.. 2023. 10. 18. 이전 1 다음 728x90 728x90
