SpringBoot學習筆記03——SpringBoot整合Swagger
阿新 • • 發佈:2018-11-12
1.新增pom依賴
向pom檔案中新增依賴
<!-- swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <!-- swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-annotations</artifactId> <version>1.5.10</version> <scope>compile</scope> </dependency>
2.新增Swagger的配置類
程式碼如下:
package com.youyou.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import io.swagger.annotations.ApiOperation; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket swaggerSpringMvcPlugin() { return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build(); } }
3.在controller中新增swagger註解
package com.youyou.address; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; /** * //TODO 新增類/介面功能描述 * * @author 劉朋 * <br/>date 2018-09-06 */ @Api(description = "第一個介面") @RestController @RequestMapping("/hello") public class HelloWorldController { @ApiOperation(value = "你好世界" ) @GetMapping("") public String helloWorld(){ return "世界你好!"; } }
4.執行效果