Spring/Spring

[swagger] 스웨거

backend dev 2022. 10. 9.

미완성.

 

 

 

 

 

 

swagger fox랑 swagger doc는 다르다.

 

fox는 업데이트가 어느순간부터 되지않는다고 한다.

 

fox, doc  원하는걸로 쓰자

 

아래는 doc로 적용법.

 

Spring Docs + Swagger 설정하기 (Spring Rest Docs 비교)

고 평소 API 문서를 적용할때는 Spring Rest Docs를 많이 사용했는데 이번 기회에 Spring Docs + Swagger ui를 적용해서 둘의 장단점 비교를 해보고 싶어서 사용해봤다. Spring Docs. + Swagger 설정 예제 개발 환..

devbksheen.tistory.com

 

SpringBoot SpringDoc(OpenAPI)을 이용한 Swagger 적용

SpringBoot로 백엔드 개발 시 API 도큐먼트를 위해 swagger를 많이 사용한다. 예전에는 springfox-swagger를 사용하여 적용하였는데 최근에 많이 사용되는 springdoc을 이용해서 swagger 설정을 해본다. 참고로 s

happy-jjang-a.tistory.com

 

 

fox로 적용법 + jwt 적용 (이걸로 했었음)

 

[Swagger UI] Annotation 설명

Annotations Swagger 설정을 먼저 하고싶다면 여기글을 먼저 읽고 오면 된다. Swagger에서 API 설명을 위한 Annotation 들을 아래에 정리한다. @ApiOperation = Method 설명 @ApiOperation으로 해당 Control

velog.io

 

[Spring] API 문서 자동화를 위한 Swagger 3.0.0 적용

목표 Swagger에 대해 알아보고, JWT Security가 적용된 Springfox 3.0을 적용해보겠습니다. 목차                                                      ..

chanos.tistory.com

 

Swagger로 API 문서 자동화를 해보자

Swagger라는 툴을 사용해서 API를 문서화 해보자.

velog.io

 


swagger에서 서버리스트 Generated server url 변경 및 추가하는법

(docs에서)

DemoApplication.java 와같이 스프링부트 시작하는 파일에다가 해당 코드 입력해서 서버추가.

 

 

Wrong "Generated server url" in springdoc-openapi-ui (Swagger UI) deployed behind proxy

Spring Boot 2.2 application with springdoc-openapi-ui (Swagger UI) runs HTTP port. The application is deployed to Kubernetes with Ingress routing HTTPS requests from outside the cluster to the serv...

stackoverflow.com

 

 

 

JWT설정할때 주의점

다음과 같은 코드가 들어갈텐데 name에 jwt를 받아오는 key값을 넣는다

 


 

 

(fox버전에서는)

return new Docket(DocumentationType.OAS_30)

처럼 swaggerconfi 파일에서 도큐멘트타입.oas_30으로바꿔준다.

 

그후는

 

아래블로그 참고

https://velog.io/@yulhee741/Swagger-servers-url-%EC%B6%94%EA%B0%80%ED%95%98%EA%B8%B0-https-%EC%B6%94%EA%B0%80

 

Swagger servers url 추가하기, https 추가

Spring Boot REST API Documentation인 Swagger사이드 프로젝트에선 springfox 라이브러리를 사용했다.서버에서 https로 매핑한 뒤에도 swagger에서 request url이 자꾸 http로 보내져 에러가 났다.포스트맨에선 보내

velog.io

 


(doc버전)swagger에서 jwt 인증받는법

 

 

Spring Docs + Swagger 설정하기 (Spring Rest Docs 비교)

고 평소 API 문서를 적용할때는 Spring Rest Docs를 많이 사용했는데 이번 기회에 Spring Docs + Swagger ui를 적용해서 둘의 장단점 비교를 해보고 싶어서 사용해봤다. Spring Docs. + Swagger 설정 예제 개발 환..

devbksheen.tistory.com

 

댓글