Swagger REST API 문서화

jb kim·2022년 3월 13일
0

REST API 블로그 앱

목록 보기
56/65

  • 엔드포인트(요청 주소) ?
  • response(응답 데이터) ?
  • payload(DTO) 설계 ?
  • 에러 코드들 ?
  • HTTP 메소드 ?
  • 에러 메세지 설명 ?

https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter/3.0.0

1. 디펜던시 추가

		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-boot-starter</artifactId>
			<version>3.0.0</version>
		</dependency>

메이븐 프로젝트 업데이트

2. SecurityConfig

/v3/api-docs 주소 모두 가능 (스웨거 주소)

			.antMatchers("/api/auth/**").permitAll()
			.antMatchers("/v3/api-docs/**").permitAll()

3. properties 설정

버전이 맞는 않는 에러 해결

## swagger error patch
spring.mvc.pathmatch.matching-strategy = ANT_PATH_MATCHER

확인

http://localhost:8080/v3/api-docs/

profile
픽서

0개의 댓글