Spring

Swagger란?

91cm 2018. 9. 17. 22:00

Swagger : Rest API로 개발시 문서를 자동으로 만들어주는 프레임워크(Spring boot 사용시)


*배경


 작은 규모의 단일 서버가 아니라면 


 보통


 사용자 → WEB, Mobile → API → DB


 위와같은 형태로 구성되어 있다.


 이런 구조에서 는 API서버가 어떤 스펙으로 데이터를 주고받는지 문서가 꼭 필요하다


 api문서를 document로 관리하면 너무 귀찮을 일이다. 그래서 API문서를 자동관리하는 Swagger가 생기게되었다.




*주의사항

 Sprimg Security사용시 Swagger에서 사용하는 URL에 대한 예외처리가 필요하다




세팅후 http://localhost:8080/swagger-ui.html페이지에 접속하면 확인할 수 있다.