Swagger란 REST API를 문서화하여 보기 편하게 시각화하고, 테스트할 수 있는 라이브러리로 서버 가동시 @RestController를 읽어서 API 분석을 해서 HTML로 문서화를 하기 때문에 API 문서를 직접 만들어서 수정시마다 일일이 수정하는 번거로움이 없어진다.
1. build.gradle
springfox-boot-starter로 추가하면 필요한 하위 라이브러리들이 전부 추가된다.
2. application.properties
spring boot 2.6.0 버전 이상인 경우에는 application.properties에서 spring.mvc.pathmatch.matching-strategy=ant_path_matcher을 추가하거나 2.6.0 밑으로 버전을 낮춰야 한다.
3. SecurityConfig
스프링 시큐리티를 사용하는 경우 해당 경로가 필터에 걸리지 않도록 permit해준다.
4. SwaggerConfig
Swagger 3.0을 사용하는 경우 Swagger2.x에서 사용하던 @EnableSwagger2 애노테이션을 사용하면 안 되고 Docket 생성시 DocumentationType.OAS_30으로 설정을 해야한다.
Swagger UI 화면을 보면 Contact와 ApiInfo에 입력한 정보들이 어디에 입력이 되는지 비교가 될 것이다.
그리고 JWT를 사용하기 때문에 관련 설정들을 해줘야 하는데 securitySchems는 API를 보호하는데 사용되는 보안 체계를 설정하는 것으로 ApiKey(또는 BasicAuth, OAuth)를 등록해서 JWT가 Authorization Header에 포함되도록 한다.
securityContext는 ApiKey로 정의한 JWT의 authorizationScope를 설정해서 SecurityReference를 포함해서 생성을 한다.
이제 실행을 하고 http://localhost:8080/swagger-ui/index.html 로 접속을 하면 아래와 같은 메인 화면이 뜬다.
Authorize를 누르면 ApiKey로 등록한 정보가 나온다.
Spring Boot를 이용한 RESTful Web Services 개발 - 인프런 | 강의
이 강의는 Spring Boot를 이용해서 RESTful Web Services 애플리케이션을 개발하는 과정에 대해 학습하는 강의으로써, REST API 설계에 필요한 기본 지식에 대해 학습할 수 있습니다., - 강의 소개 | 인프런..
www.inflearn.com
Springfox Reference Documentation
The Springfox suite of java libraries are all about automating the generation of machine and human readable specifications for JSON APIs written using the spring family of projects. Springfox works by examining an application, once, at runtime to infer API
springfox.github.io
[swagger3] 설정 및 authroize button 활성화하기(Bearer 사용)
버전 2보다 좋은 점은 url에 다음과 같이 되어있을때 http://localhost:9001/swagger-ui/index.html#/1.Login/loginUsingPOST 브라우저로 접속하면 해당 api가 바로 펼쳐지면서 이동한다. (아마 그게 전부... 대신..
lemontia.tistory.com
Spring Boot Swagger 3.x 적용
1. Swagger 란? Swagger 는 OAS(Open Api Specification)를 위한 프레임워크입니다. 개발자들의 필수 과제인 API 문서화를 쉽게 할 수 있도록 도와주며, 파라미터를 넣어서 실제로 어떤 응답이 오는지 테스트도
bcp0109.tistory.com
Spring Boot2.6에서 Springfox3 실행 실패 에러
Intro Kotlin 프로젝트 였지만, Spring Boot 설정과 관련된 내용이기 때문에 java 로 프로젝트를 진행 하시는 경우에도 문제 해결을 하실 수 있습니다. Kotlin 과 스프링 부트를 이용해 API 서버를 만드는
shanepark.tistory.com
SpringBoot 2.6 이상 springfox-swagger3.0 적용 시 에러 해결
원인 spring boot 2.6.0부터 요청 경로를 ControllerHandler에 매칭시키기 위한 전략의 기본값이 ant_path_matcher 전략 -> path_pattern_parser 전략으로 변경되었기 때문이다. 해결 방안 2가지 application
velog.io
'Spring' 카테고리의 다른 글
| [Spring Rest Docs] Rest API 문서화 (0) | 2023.01.28 |
|---|---|
| [Spring] 템플릿 메서드 패턴, 팩토리 메서드 패턴 (0) | 2022.10.04 |
| Redirect와 Forward 차이점 (0) | 2022.09.27 |
| [Spring] 스프링 시큐리티(Spring Security) + JWT 토큰 구현(2) (0) | 2022.09.20 |
| [Spring] 스프링 시큐리티(Spring Security) + JWT 토큰 구현(1) (0) | 2022.09.19 |