개발일지 시작의
제발 꼼꼼하게 읽어보자!!!!!!!!!
개발 업무내용
배포 성공했다 코드 리팩토링을 했지만 생각보다 시간이 많이 필요해서 원하는 만큼 수정하지 못해서 좀 아쉽다... 내일 발표준비하고 시간이 남으면 도전해봐야겠다
오늘의 이슈/고민..그리고 해결한 내용
spring rest docs는 test코드가 있어야 만들 수 있다고해서 시간이 부족한 우리는 swagger를 이용하기로 했다. 여러 블로그를 참고해봤지만 다 제대로 ui가 안나와서 조금 헤매다가 성공했다!!
Spring bood Gradle에서 Swagger로 API문서 자동화하기
- 의존성 추가
//swagger
implementation 'org.springdoc:springdoc-openapi-ui:1.5.13'-
SwaggerConfig 클래스를 추가할 config 패키지 만들기
-
SwaggerConfig 클래스 작성
public class SwaggerConfig {
@Bean
public GroupedOpenApi publicApi() {
return GroupedOpenApi.builder()
.group("bbichul.site")
.pathsToMatch("/api/**")
.packagesToScan("site.bbichul.controller")
.build();
}
}group은 프로젝트 만들 때 작성한 그룹
pathToMatch은 문서로 남겨둘 컨트롤러만 적용시킬 수 있는데 우리는 모든 mapping value가 /api/~ 형식으로 시작해서 저렇게 작성했고
PackagesToScan스캔할 api가 있는 패키지 경로로 우리 프로젝트의 api는 모두 controller 패키지에 있어 저렇게 작성했다
- 어노테이션으로 부가설명을 작성
@Operation(description = "팀 소속 여부 확인", method = "GET")우리는 method를 사용했지만 example을 이용해 예시값을 넣어줄 수도 있다
try it out 버튼으로 테스트도 해볼 수 있다고 하는데 나는 안해봤음 내일이나 모레 해봐야겠다
전부 잘 적용이 됐다면 이 주소로 들어가 내 프로젝트의 api 문서를 확인할 수 있다!!
To-do List
발표준비, 알고리즘, 시간나면 코드 리팩토링
