SpringBoot2.0集成Swagger2,生成在线文档

1.导入pom依赖

        <!-- swagger2 -->
		<dependency>
		    <groupId>io.springfox</groupId>
		    <artifactId>springfox-swagger2</artifactId>
		    <version>2.8.0</version>
		</dependency>
		<dependency>
		    <groupId>io.springfox</groupId>
		    <artifactId>springfox-swagger-ui</artifactId>
		    <version>2.8.0</version>
		</dependency>
		<dependency>
     		<groupId>com.github.xiaoymin</groupId>
     		<artifactId>swagger-bootstrap-ui</artifactId>
     		<version>1.9.5</version>
 		</dependency>

2.swagger相关配置

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;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger2在线文档测试")
                .description("系统描述")
                .termsOfServiceUrl("服务URL")
                .contact("作者")
                .version("1.0")
                .build();
    }

}

3.应用示例

import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.example.demo.Demo;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;

@Api("测试类")
@RestController
public class DemoController{

	@RequestMapping(value = "demo",method = RequestMethod.GET)
	@ApiOperation(value="GET测试", notes="GET测试")
    @ApiImplicitParam(name = "param", value = "参数", required = true, dataType = "String")
	public String demo1(String param) {
		return "返回为:"+param;
	}
	@RequestMapping(value = "demo2",method = RequestMethod.POST)
	@ApiOperation(value="POST测试", notes="POST测试")
	public String demo2(@RequestBody @Validated Demo demo) {
		
		return demo.toString();
	}
	@RequestMapping(value = "demo3",method = RequestMethod.GET)
	@ApiOperation(value="多参数GET测试", notes="多参数GET测试")
	@ApiImplicitParams({
    @ApiImplicitParam(name = "param1", value = "参数1", required = true, dataType = "String"),
    @ApiImplicitParam(name = "param2", value = "参数2", required = true, dataType = "String"),
    })
	public String demo3(String param1,String param2) {
		return "返回:"+param1;
	}
}
import io.swagger.annotations.ApiModelProperty;

public class Demo {
	
	@ApiModelProperty(name="姓名",required=true)
	private String name;
	@ApiModelProperty(name="密码",required=false)
	private String pwd;
	
	
	//get、set省略
	
	
}

4.效果图

访问http://localhost:8081/doc.html 或 http://localhost:8081/swagger-ui.html

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值