关于 boot项目 整合swagger的使用 亲测好用 !!!

作为一名java 的爬坑人员 我感觉倍感艰辛

第一在 pom.xml 文件中 加入对应的坐标

<!--swagger-api 依赖开始-->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>
		<!--美化swagger-->
		<dependency>
			<groupId>com.github.xiaoymin</groupId>
			<artifactId>swagger-bootstrap-ui</artifactId>
			<version>1.9.3</version>
		</dependency>
		<!--swagger-api 依赖结束-->

第二 添加 swagger 配置文件 代码如下 不要导错包哦

package com.zsdn.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;
/**
* @Description:    配置swagger
* @Author:         wangsh
* @CreateDate:     2019/10/30 15:33
* @UpdateUser:     wangs

* @UpdateDate:     2019/10/30 15:33
* @UpdateRemark:   修改内容
* @Version:        1.0
*/
@Configuration
@EnableSwagger2
public class SwaggerTwo {
    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(true)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zsdn.controller")) //对应你的controller 包名
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息(这些基本信息会展现在文档页面中)
     * 访问地址:http://项目实际地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("项目API测试") //标题
                .description("测试接口") // 文档接口描述
                .contact("wangs")
                .version("1.0")//版本号
                .build();
    }

}

第三 这是默认界面

在这里插入图片描述

感觉不好看 所以 进行替换呢

package com.zsdn.config;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.spring.web.SpringfoxWebMvcConfiguration;

/**
 * Created by 51589 on 2019/10/31.
 */
@SpringBootApplication
@ConditionalOnClass(SpringfoxWebMvcConfiguration.class)
public class WebMvcConfig implements WebMvcConfigurer{
    @Override
     public void addResourceHandlers(ResourceHandlerRegistry registry) {
           registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
           registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
     }
}

最后一步 在启动类上添加注解 @EnableAutoConfiguration 完成

访问http://localhost:端口/doc.html
在这里插入图片描述

自此 就完成了 至于 整合shiro 本人正在摸索中 留言区 欢迎讨论 加油 !!!

发布了89 篇原创文章 · 获赞 47 · 访问量 1万+

猜你喜欢

转载自blog.csdn.net/weixin_43726822/article/details/102889025