springboot集成swagger的步驟是什么

這篇文章主要介紹“springboot集成swagger的步驟是什么”，在日常操作中，相信很多人在springboot集成swagger的步驟是什么問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”springboot集成swagger的步驟是什么”的疑惑有所幫助！接下來，請跟著小編一起來學習吧！

    第一步：maven導入Swagger如下：

 <!-- 添加使用swagger的依賴包 --><dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.2.2</version>
 </dependency>
 <!-- 添加使用swagger的依賴包 -->
 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.2.2</version>
 </dependency>

第二步：創建Swagger2配置類，如下所示：

/**
 * 
 */
package swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author ignore1992
 *
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig
{
	@Bean
	public Docket createDocket()
	{
		return new Docket(DocumentationType.SWAGGER_2)
		.apiInfo(createApiInfo())
		.select()
		.apis(RequestHandlerSelectors.basePackage("swagger.api.controller"))
		.paths(PathSelectors.any())
		.build();
	}

	private ApiInfo createApiInfo()
	{
		return new ApiInfoBuilder()
		.title("springboot使用swagger2")
		.description("生成對應接口文檔")
		.termsOfServiceUrl("https://blog.csdn.net/ignorewho")
		.contact("ignore1992")
		.version("1.0")
		.build();
	}
}

第三步：這樣就可以使用swagger提供的注解，來完成描述，調用，生成等功能

常用注解如下：

@Api : 用在類上，說明該類的主要作用。

@ApiOperation：用在方法上，給API增加方法說明。

@ApiImplicitParams : 用在方法上，包含一組參數說明。

@ApiImplicitParam：用來注解來給方法入參增加說明。

使用案例如下：

/**
 * 
 */
package swagger.api.controller;

import io.swagger.annotations.ApiOperation;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author ignore1992
 *
 */
@RestController
@RequestMapping(value = "/swaggerapi")
public class SwaggerApiController
{
	@ApiOperation(value = "測試swaggerapi接口方法")
	@RequestMapping(value = "/test", method = RequestMethod.GET)
	public String test()throws Exception
	{
		return "swaggerapi 測試";
	}
}

到此，關于“springboot集成swagger的步驟是什么”的學習就結束了，希望能夠解決大家的疑惑。理論與實踐的搭配能更好的幫助大家學習，快去試試吧！若想繼續學習更多相關知識，請繼續關注億速云網站，小編會繼續努力為大家帶來更多實用的文章！