※ [Spring Boot Tutorial] 16. Swagger v3에 HTTP 기본인증(Basic Authentication) 설정하기 과정을 먼저 선행한 후 진행해주세요. Bearer 기본 Bearer + JWT? JWT? JWT 라이브러리 추가 JwtBuilder 구조 Bearer + JWT api에 적용 프로퍼티에 jwt 설정 추가 token 생성 api @Aspect를 이용한 token 유효성 검사 Swagger 테스트 Access-Control-Allow-Headers 설정 swagger 테스트 1. Bearer 기본 OpenAPI config Swagger Info에 인증 헤더 설정을 추가합니다. @Component public class OpenApiConfig { @Bean public..

Security Scheme? Basic Authentication? securityScheme 설정 추가 Authorization 헤더 관련 익셉션 발생 @ControllerAdvice 를 이용한 익셉션별 response 설정 1. Security Scheme? OpenAPI 3에서는 리소스에 액세스할 때, 액세스 권한이 있는지에 대한 인가처리를 위해 security scheme(보안체계)를 사용합니다. OpenAPI 3에서 제공하고 있는 보안체계는 4가지가 있으며, 그에 대한 정보는 아래와 같습니다. http HTTP Authentications schema를 이용하는 방식 Authorization 헤더를 이용하는 방식 ex) Basic, Bearer 등... apiKey API key 헤더를 이용한..

api 그룹 설정 : @Tag api Schema 설정 : @Schema api 상세 정보 설정 : @Operation api response 설정 : @ApiResponse api parameter 설정 : @Parameter 이전시간에 OpenAPI info 정보만 설정했었습니다. Schemas 에 대한 설명과 들어갈 값에대한 정보도 없고, api method에 대한 설명도 없어서 api 이용에 불편함이 있습니다. 이번시간에는 Swagger v3 Annotation을 이용하여 API 문서의 설명을 구체적으로 작성하고, Java Bean Validation 을 이용하여 api 사용시 유효성 체크를 합니다. 1. api 그룹 설정 : @Tag Target : ANNOTATION_TYPE, METHOD, ..

웹 애플리케이션을 배포할 때, 서버 환경별로 값을 달리해야 하는 값들이 있을 수 있습니다. 예를들면, 로컬에서 테스트하는 database 접속 정보와 실 서버에서 이용하는 database 접속 정보가 다를 수 있을 것이고. 그 외에도 특정 폴더 경로의 절대경로의 경우에도. 리눅스 기반 서버와 Windows 서버의 폴더구조가 다르기에 값을 달리 작성해야하는 필요가 생깁니다. [Spring Boot] 프로퍼티 파일(yml) 여러개 설정하기 포스팅에서는 긴 프로퍼티 파일을 성질에 따라 쪼개어, 2개 이상의 프로퍼티 파일을 읽어들이는 방법을 알아보았다면, 이번 시간에는 서버 환경별로 활성화 시킬 프로퍼티 파일을 선택하여 배포할 수 있도록 하는 방법을 배워볼 것입니다. 프로파일 폴더 구조 프로파일별 프로퍼티 설정..

OpenAPI 3.0 OAS 란? Swagger 란? springdoc-openapi 설정 의존성 라이브러리 추가 프로퍼티 설정 (operations-sorter, display-query-params-without-oauth2) Swagger Info 설정 Swagger-ui 실행 /swagger-ui/index.html Swagger-ui 실행 및 csrf token 문제점 2. 설정 2.1. 의존성 라이브러리 추가 pom.xml에 springdoc-openapi 을 추가합니다. org.springdoc springdoc-openapi-ui 1.6.6 2.2. 프로퍼티 설정 springdoc: version: '@project.version@' api-docs: path: /api-..

지금까지 demo프로젝트를 구성할 때, @ResponseBody의 result와 reason 값에 api 요청 결과를 출력했습니다. 그러나, http 프로토콜을 이용하는 통신에는 응답결과를 body이외에 http 상태 코드와 header 를 설정하여 보다 세밀하게 response를 표현할 수 있습니다. ResponseEntity는 HtttHeaders headers와 T body, HttpStatus status를 포함한 클래스입니다 ResponseEntity를 이용하여 demo 프로젝트를 HTTP response 규약을 지키는 rest api로 만들어봅시다. 이론 1-1) HTTP 상태 코드 1-2) 전략 1-3) 기존 api (변경 전) 1-4) 새로 변경될 api 1단계 : Response 클래스 ..