swagger

[Spring] Swagger Api문서 작성하기

주요 어노테이션 @Api : 해당 어노테이션을 설명합니다 @ApiOperation(value = "제목", note = "설명") @ApiImplicitParam(name = "파라미터", value = "파라미터 값") @ApiIgnore : 명세서에 표시하지 않는 것을 의미합니다. @ApiModelProperty : dto에 작성. 예시를 넣을 수 있습니다. 주로 컨트롤러에서 사용되고 @ApiModelProperty만 dto에서 사용됩니다. 컨트롤러 @Api @Api 어노테이션을 통해 아래와 같이 Controller의 명칭을 변경할 수 있습니다. @Api(tags = {"게시글 API"}) // Swagger 최상단 Controller 명칭 public class BoardController { ....

[Spring] Swagger3 적용하기

먼저 build.gradle에 Swagger에 필요한 의존성을 주입해줍니다. // Swagger implementation 'io.springfox:springfox-boot-starter:3.0.0' 그리고 Application.yml에 아래의 코드를 추가해줍니다. spring: mvc: pathmatch: matching-strategy: ant_path_matcher 그다음 SwaggerConfig.java를 추가합니다. @Configuration public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.OAS_30) .useDefaultResponseMessages(false) .selec..