[멋쟁이 사자처럼] 해커톤 준비(2) - swagger-ui 연결

원랜 소셜로그인을 바로 쓸 예정이였는데,
막간을 이용해 swagger-ui 연결도 바로 적어보려고 합니다

1. 의존성 추가하기

// swagger-ui
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'

2. application.yml

springdoc:
  api-docs:
    path: /api-docs
  swagger-ui:
    path: /swagger-ui

3. 접속해보기

http://localhost:8080/hackathon/api/swagger-ui/index.html#/

참고
저는 기본 url을 /hackathon/api/ 여기까지 해놨었습니다

4. 필요시 Controller에 어노테이션 추가

@RestController
@RequestMapping("/users")
public class UserController {

    @GetMapping("/login")
    @Operation(summary = "로그인", description = "로그인 성공시 토큰반환")
    public ResponseEntity<LoginResponseDto> login(@RequestBody LoginRequestDto request){
        // ...
    }
}

어노테이션 @Operation을 통해
api 이름과 설명을 적어줄 수 있습니다

위와 같이 설정한 결과 예시