📢TMI📢

이제 얼마 안남았누

✍TIL(Today I Learned)✍

Swagger로 API 문서 자동화 하기

왜 API 문서를 자동화 할까? API를 만들때 프론트 엔드 개발자들과의 소통을 원할하게 하기 위해서

스웨거를 사용한 이유: 적용하기 쉬워서 Spring REST Docs라는 문서화 도구와는 달리 Swagger는 코드 몇 줄만 추가하면 만들 수 있기때문

1. dependencies에 swagger api 추가

2. 스프링 서큐리티를 사용한다면 요것도 추가

3. config 패키지를 만들고 클래스를 만든다

package site.bbichul.config;


import org.springdoc.core.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {
    @Bean
    public GroupedOpenApi openApi(){
        return GroupedOpenApi.builder() // 사용
                .group("bbichul.shop") // swagger 에나오는 definition
                .pathsToMatch("/api/**") //api에 해당하는 거 다
                .packagesToScan("site.bbichul.controller")컨트롤 패키기 몽땅
                .build();
    }



}

4. 컨틀롤러 패키지 안에 있는 api 앞에 /api 달기

5.URL 이렇게 적어주고 짜잔

6. 아주 좋은 정보가 나옴

👁‍🗨TIF(Today I Feel) 👁‍🗨

오늘은 막상 엄청 어렵게 느껴졌던 API 문서 자동화란 것을 해보았다 굳이 api 문서를 열심 썼는데 이거까지 해야하나 라는 생각이 들었지만 이유를 또 찾아보니 그럴만 하다고 느꼈다 우리가 프론트와 협업을 할 때 있어서 그냥 api 문서를 보는것보다는 저렇게 자동화해서 response와 request가 보여지는 문서를 주면 프론트 쪽에서 보다 편하게 개발에 임할 수 있기 때문이었다 그래도 협업을 하면서 좋은 결과물을 얻기 위해서 꼭 필요한 과정이라고 생각도 들었다 또 새로운것을 배우며 알아가는 순간 재밌다

📢 To-do list📢

1.리팩토링 열심히 해보기
2.발표준비

<출처>