添加swagger

前后端分离开发时,前端如何得知后端的接口名称以及参数,后端如何调试自己的端口是否正确是一个很严肃的话题,swagger为这些问题提供了很大的便利

1、在pom文件加依赖

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

2、新建一个 java 类 

@Bean
    public Docket buildDocket() {
        return  new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())//调用下面apiInfo()方法
                .select()
                //Controller所在路径
                .apis(RequestHandlerSelectors.basePackage("com.unicom.news.controller"))  // controller 所在包名
                .paths(PathSelectors.any())
                .build();
      }
 
    public ApiInfo apiInfo() {
            return  new ApiInfoBuilder()
                    .title("springboot结合swagger2构建Restful API")
                    .description("这是一个swagger2小型demo")
                    .termsOfServiceUrl("localhost:8080")
                    .version("0.0.1")
                    .build();
 
     }

3、启动项目后,打开浏览器,在浏览器输入http://localhost:8080/swagger-ui.html 即可查看端口,以及端口的method,参数

/**********************************   转载请附上链接 https://www.cnblogs.com/renxq/p/11075272.html ***********************************/

posted @ 2019-06-24 08:57  十八亿少女的梦  阅读(743)  评论(0)    收藏  举报