swagger

[Swagger] Swagger를 이용해 API 문서를 자동으로 만들어보자

[Swagger] API 명세도구를 사용해보자 왜 쓰게 됬나면... 사이드 프로젝트로 MSA 프로젝트를 하고있는데, API 명세가 확실하게 되어있지 않아 아래의 문제점이 발생했다. 내가 구현한 API가 정말 RESTful 한지 알 수 없었다. 클라이언트 프 logical-code.tistory.com 이전 포스팅에 이어, 이번에는 Swagger를 이용해서 API 문서를 자동으로 만들어보도록 한다. 아래 예제는 현재 진행중인 사이드 프로젝트를 대상으로 적용했다. 의존성 추가 사이드 프로젝트가 Maven 으로 의존성을 관리하고 있으므로, Maven 기준으로 설명합니다. pom.xml에 아래 의존성을 추가합니다. io.springfox springfox-swagger2 2.9.2 io.springfox spr..

[Swagger] API 명세도구를 사용해보자

왜 쓰게 됬나면... 사이드 프로젝트로 MSA 프로젝트를 하고있는데, API 명세가 확실하게 되어있지 않아 아래의 문제점이 발생했다. 내가 구현한 API가 정말 RESTful 한지 알 수 없었다. 클라이언트 프로젝트에서 요청을 보내야할 API를 찾기위해 관련 프로젝트를 모두 열어 확인해야했다. Rabbit MQ를 이용해 프로세스간 통신을 구현해야 하는데, 설계에 대한 내용이 없어 프로세스간 통신을 설계하기가 힘들 것 같았다. 그래서 각 어플리케이션별 구현한 API를 취합해 엑셀로 정리를 해봤다. 그런데 여기서 또 문제가 발생했는데 일일이 엑셀 파일에 구현 내용이나 설계 내용을 입력해야했다. 그래서 매우 귀찮았다. 그런데 엑셀 파일이 없어지면 이 수고로움이 헛수고가 됬다. 그리고 세련되지 않은 방법이었다...