Swagger 사용하기

pom.xml에 denpendency 추가

---

<!-- Swagger setting -->
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.9.2</version>
</dependency>

 

 

SwaggerConfig class 추가

---

// http://localhost:9999/jpa/swagger-ui.html
@Configuration
@EnableSwagger2
public class SwaggerConfig {

	@Bean
	public Docket postsApi() {
		return new Docket(DocumentationType.SWAGGER_2)
				.groupName("jpa Test")
				.apiInfo(apiInfo())
				.select()
				.apis(RequestHandlerSelectors.basePackage("com.ssafy.jpa"))
				.paths(PathSelectors.ant("/api/**"))
				.build();
	}

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder().title("API")
				.description("API Reference for Developers")
				.version("1.0").build();
	}
}

 

해당 클래스를 추가합니다.

이 swagger는 com.ssafy.jpa라는 package 밑에 있는 파일들을 보게 됩니다.

또한 경로가 /api 밑에 있는 함수들을 보게 됩니다.(수정 필요)

 

 

Controller에 api 추가

---

@ApiOperation(value = "product에서 name찾기.", response = List.class)

 

Controller의 경로를 잘 설정한 이후, Controller의 함수에 위의 어노테이션을 붙여줍니다.

value와 response는 상황에 맞게 쓰시면 됩니다.