Swagger

• Swagger
  REST 웹 서비스를 제공하려면 프론트엔드 개발자에게 전달해줄 API문서가 필수
  그런 문서를 작업해서 전달해주는건 수고로운 일
  그래서 나타난게 Swagger이며, 이것은 문서뿐 아니라 빌드, 테스트 케이스, 등도 작성 가능

  스웨거(Swagger)는 
  개발자가 REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다. 
  대부분의 사용자들은 스웨거 UI 도구를 통해 스웨거를 식별하며 스웨거 툴셋에는 자동화된 문서화, 코드 생성, 테스트 케이스 생성 지원이 포함된다.  / 위키 백과

구현

1. build.gradle 설정

실질적으로 필요한 코드 implementation group: 'io.springfox', name: 'springfox-boot-starter', version: '3.0.0'

2. Controller 등록

3. 서버실행 후 Swagger UI 접속

서버를 실행 한 후 로컬서버에 기본포트(8080)인 경우 http://localhost:8080/swagger-ui/ 접속

• Swagger 3.x인 경우 http://localhost:8080/swagger-ui/
• Swagger 2.x인 경우 http://localhost:8080/swagger-ui.html

4. 설정 및 옵션

• @Api: 해당 컨트롤러에 내용을 설정
• @ApiImpicitParams: 컨트롤러에 매핑될 파라미터들에 설정
• @ApiImpicitParam: 매핑될 파라미터 하나의 내용을 설정
• @ApiResponse: 응답 코드에 대한 설명
• @ApiOperation: 매핑 메소드에 대한 설명

응답을 받긴 했지만 이게 맞는지 모르겠다