search

daehwan2yo / msa-playground

MSA 를 멀티모듈기반으로 연습합니다.
2 stars 0 forks source link

Swagger 를 사용한 API 문서화 #2

Open daehwan2yo opened 2 years ago

daehwan2yo commented 2 years ago

내용

MSA에 접근할 때 참고할 수 있는 API 를 swagger 및 Spring fox 를 사용해 문서화한다.

목적

접근이 쉬운 좋은 문서를 통해 유용하게 API 를 사용할 수 있게한다.

참고

end-to-end 에 대해서,
기존 monolithic 과 달리 MSA 에서는 다른 API server 도 client 가 될 수 있다.
(꼭 front, mobile, 실제 사용자 만이 client 가 아니라는 의미)

daehwan2yo commented 2 years ago

공식문서) https://springfox.github.io/springfox/docs/current/#getting-started

후에 non-blocking 한 response (Mono, Flux) 에 대한 처리도 추가해줘야함 참고 ) https://itstory.tk/entry/springbootstarterwebflux-swagger-3-%EC%84%A4%EC%A0%95