swagger ui에서 api를 테스트하면서 인증을 사용하고 싶은 경우 어떻게 하면 될까?swagger는 이와 관련하여 securityScheme를 제공한다.@SecurityScheme annotation을 사용하거나 OpenAPI 설정의 securityScheme 항목을 설정하면 된다.springdoc 문서에는 OpenAPI 설정에 대한 예시가 있다.https://springdoc.org/#how-can-i-define-securityschemeSecuritySchema 설정하기 @Bean public OpenAPI customOpenAPI(@Value("${springdoc.version}") String appVersion) { return new OpenAPI() .components(new..

swagger annotation을 사용하여 문서화 작업을 하면 너무 많은 양의 swagger annotation이 오히려 코드의 가독성을 많이 떨어트리게 되어 이에 대해 좀 더 정리하여 사용해보려고 한다. swagger annotation에 대한 자세한 설명은 아래 github wiki에 있다. https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations 설정하기 spring boot 프로젝트에서 springdoc-openapi의 사용은 다음과 같이 의존성을 추가하면 된다. webmvc의 경우 아래 dependency를 추가하고 webflux인 경우 springdoc-openapi-starter-webflux-ui를 추가하면 된다..

Spring Rest Docs 또는 springdoc-openapi를 사용하여 생성한 OpenAPI 문서를 Swagger UI에서 사용하는 것에 대해 소개한 적이 있다. 2022.06.17 - [Study/Java] - Spring Rest Docs로 OpenAPI (Swagger) 문서를 만들어 Swagger UI로 호출하여 보기 Swagger UI를 사용해보니 OpenAPI 문서를 생성하여 테스트를 할 수 있는 부분은 편리하지만 테스트를 할 때마다 테스트한 데이터에 대한 재사용하는 것이 불편하였다. 테스트하기 위한 데이터를 보관하는 좋은 방법이 없나 찾아보다가 postman이 openapi를 import 하여 사용할 수 있다는 것을 알게 되었다. postman은 API를 테스트하거나 모니터, mock..

이 글의 내용은 Spring Rest Docs를 이미 사용하고 있는 상황에서 OpenAPI 문서를 만들기 위한 내용을 담고 있습니다. OpenAPI Specification 소개 OpenAPI Specification은 예전엔 Swagger Specification으로 알려졌었다. OpenAPI Specification은 Rest API에 대해 문서화를 하기 위한 사양을 정의한 것으로 특정한 소프트웨어나 라이브러리가 아니다. SmartBear Software 회사가 자사 swagger framework에서 REST Api를 문서화하기 위해 사용하던 Swagger Specification을 공개하면서 Linux Foundation의 OpenAPI Initiative project로 관리가 이전되었다. ht..