SpringBoot整合Swagger

    本文演示SpringBoot整合Swagger。
一、项目搭建
    新建一个SpringBoot项目,引入依赖:
    

<properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--swagger配置-->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.8.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    </dependencies>

二、配置文件
    配置项目端口号:

server:
  port: 8899

三、Swagger配置类

@Configuration
@EnableSwagger2
public class Swagger2Configure {
    /**
     * API及扫描配置
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demoswagger.controller"))
                .paths(PathSelectors.any()).build();
    }

    /**
     * 展示信息
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("api文档")
                .version("1.0").build();
    }
}

四、编码实现
    ①编写Controller类及测试请求方法:

@Api(tags = "demo测试")
@RestController
public class DemoController {

    @ApiOperation("test")
    @PostMapping("/test")
    public String test(String name){
        return "Hello,"+name;
    }
}

    ②启动类

@SpringBootApplication
public class DemoSwaggerApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoSwaggerApplication.class, args);
    }
}

   ③启动项目并访问http://localhost:8899/swagger-ui.html:


测试验证OK。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值