關於 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 本人正在摸索中 留言區 歡迎討論 加油 !!!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章