美文网首页Spring cloud
Springboot项目快速搭建Swagger2.0

Springboot项目快速搭建Swagger2.0

作者: 雨末夏伤 | 来源:发表于2019-01-17 16:32 被阅读66次

    如今相信大部分公司都已经实现前后端分离的开发模式,所以前后端沟通成为不可避免的问题,怎么更加清晰明了的进行交接,API文档是不可避免的,所以Swagger还是值得推荐的

    虽然也不是特别的满意,比如代码的移入性较高,可是总体来说看起来还是比较明了的

    一、配置依赖:

    <!-- swagger2.0依赖 -->

    <dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger2</artifactId>

    <version>2.6.1</version>

    </dependency>

    <dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger-ui</artifactId>

    <version>2.6.1</version>

    </dependency>

    二、进行配置

    代码如下:

    @Configuration

    @EnableSwagger2

    public class SwaggerConfig {

    @Bean

    public Docket buildDocket() {

    return new Docket(DocumentationType.SWAGGER_2).apiInfo(buildApiInf()) // .apiInfo(apiInfo())

    .select().apis(RequestHandlerSelectors.basePackage("com.yq"))// 要注释的接口名

    .paths(PathSelectors.any()).build();

    }

    private ApiInfo buildApiInf() {

    return new ApiInfoBuilder().title("自己测试 API").termsOfServiceUrl("http://wapp.ncyunqi.com").version("1.0.0")

    .build();

    }

    }

    三、在启动项进行配置注解@EnableSwagger2 表示开启Swagger

    四、打开访问页面

    相关文章

      网友评论

        本文标题:Springboot项目快速搭建Swagger2.0

        本文链接:https://www.haomeiwen.com/subject/mdtidqtx.html