swagger基本使用

接口文档或多或少都接触过，但是由于得不到及时更新，导致前后端不能同步保持一致，但是要后端去写一个接口文档又是比较头疼的，（大多数都不愿意亲自写..写过的都知道，真的很浪费时间）

有麻烦就会有解决方式，swagger就很好的帮助懒惰的程序员解决了这个烦恼，记录一下我的使用方式

idea导入swagger的依赖

<dependency>
  <groupId>com.spring4all</groupId>
  <artifactId>swagger-spring-boot-starter</artifactId>
  <version>1.9.1.RELEASE</version>
</dependency>

 提供配置类交由spring管理

@Configuration
@EnableSwagger2//开启swagger
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.file"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 在apiInfo中，主要配置一下Swagger2文档网站的信息，
     *      例如网站的title，网站的描述，联系人的信息，使用的协议等等
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger自助配置")
                .description("测试")
                .termsOfServiceUrl("http://192.168.1.198:10070/platformgroup/ms-admin")
                .contact(new Contact("张三", "http://www.baidu.com", "XX@qq.com"))
                .version("9.0")
                .license("apache swagger")
                .licenseUrl("http://www.sina.com")
                .build();
    }

}

 项目启动类上启动swagger

application.properties中开启

之后就可以在代码上使用swagger提供的注解标注了

如：

标注接口方法参数：

 标注实体属性：

做完这些就可以启动项目查看了

首先可以查看swagger生成的接口的json文件，生成的地址：项目地址+/v2/api-docs

如：

拿到json看着不习惯使用在线json转换即可

浏览器ui查看（首先需要ui包）

在浏览器中输入：项目地址+swagger-ui.html

如：

 测试接口点击try it out

 简单使用就这么多，记录笔记加深印象