swagger2 API文档的框架配置

随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。
前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，swagger就是一款让你更好的书写API文档的框架。

pom.xml 添加依赖

<!-- Restful API接口说明 生成  swagger  -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.5.0</version>
   <scope>compile</scope>
</dependency>



<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.5.0</version>
   <scope>compile</scope>
</dependency>

controller内容

@RequestMapping(value = "/per/{id}", method = RequestMethod.GET)
@ApiOperation(value = "测试", notes = "测试逆向工程")
public ResultVO selectByPrimaryKey(@PathVariable("id")Integer id) {

   per  perLIst= userservice.selectByPrimaryKey(id);


   return ResultVOUtil.success(perLIst);

}

swagger2文件内容

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
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 Swagger2 extends WebMvcConfigurerAdapter {

   @Override


   public void addResourceHandlers(ResourceHandlerRegistry registry) {
      registry.addResourceHandler("swagger-ui.html")
            .addResourceLocations("classpath:/META-INF/resources/");

      registry.addResourceHandler("/webjars/**")
            .addResourceLocations("classpath:/META-INF/resources/webjars/");
   }

   @Bean
   public Docket createRestApi(){
      return  new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
            .paths(PathSelectors.any())
            .build();
   }


   private ApiInfo apiInfo(){
      return new ApiInfoBuilder()
            .title("文档")
            .description("提供给外部系统的服务接口，进行管理业务。")
            .termsOfServiceUrl("http://terms-of-services.url")
            .version("1.0")
            .build();
   }
}

访问地址：http://localhost:8085/swagger-ui.html

扫描二维码关注公众号，回复： 185588 查看本文章

可以测试很方便点Try it out！

我的demo用的事JSON传数据用的RESTful风格 get 查询 post 创建 put 更新 del 删除都可以测试

swagger2 API文档的框架 配置

猜你喜欢

swagger2 API文档的框架配置