이전 포스팅에서 swagger 에 다룬 글이 있다.
자세한 내용은 참고 포스팅을 참고 바란다.
비록 해당 swagger는 springfox 의 swagger 이고
오늘 다루는 포스팅은 springdoc에 존재하는 swagger 이다.
설정은 yml 파일에서 할수 있다.
첫번째 옵션은
tags-sorter
사용법은 아래와 같다.
| springdoc: swagger-ui: tags-sorter: default |
default 를 포함해서 가질수 있는 값은
- alpha: 태그를 알파벳 순서로 정렬
- default: 태그를 정의된 순서대로 표시
이다.
두번째 옵션은
operations-sorter
사용법은 아래와 같다.
| springdoc: swagger-ui: operations-sorter: method |
default 를 포함해서 가질수 있는 값은
- alpha: 경로를 알파벳 순서로 정렬
- method: HTTP 메소드 순서대로 정렬 (예: GET, POST, PUT, DELETE).
- default: 경로를 정의된 순서대로 표시
이다.
세번째 옵션은
paths-sorter
사용법은 아래와 같다.
| springdoc: swagger-ui: operations-sorter: method |
default 를 포함해서 가질수 있는 값은
- alpha: 경로를 알파벳 순서로 정렬
- default: 경로를 정의된 순서대로 표시
이다.
설정하고 application 을 재실행하면 swagger 에서 정렬된 순서로 api들을 만나볼수 있다.
참고 포스팅
https://thenicesj.tistory.com/252
swagger-ui 사용법
스웨거란 RESTAPI 개발시 문서를 자동으로 만들어주는 프레임워크이다. 대부분 API 를 Request 날릴때 사용을 하곤 한다. 저번에 다뤘던 내용인 postman을 사용해도 되고 이 swagger를 사용해도 좋다. postm
thenicesj.tistory.com
https://thenicesj.tistory.com/447
Open API 3.0 Swagger v3 상세설정(23/01/08)
이전 포스팅에서 swagger 기능에 대해 다룬적이 있다. 아래 참고사이트에서 확인할수 있다. 이번 포스팅에서는 swagger 를 좀더 상세설정을 통해서 사용할수 있는 기능을 몇가지 적어보려고 한다. ap
thenicesj.tistory.com
'IT > Java' 카테고리의 다른 글
| H2 DB 3가지 모드 사용(Embedded, In-Memory, Server) (15) | 2024.06.01 |
|---|---|
| [SpringBoot] H2 Localhost에서 연결 거부(securityConfig/X-Frame-Options) (6) | 2024.05.31 |
| JPA query did not return a unique result 에러 (11) | 2024.05.29 |
| CORS 설정시 allowedOrigins (16) | 2024.05.28 |
| No Creators, like default construct, exist): cannot deserialize from Object value (no delegate- or property-based Creator (16) | 2024.05.27 |
댓글