springfox-swagger之swagger-bootstrap-ui

swagger-bootstrap-ui是國內的一個swagger開源項目,從發起到如今已經有三年了。
初次體驗了一下,以爲仍是挺不錯的,就如當初使用mybatis-plus那樣,由於有了mybatis的基礎,因此過渡到mybatis-plus很沒有壓力。
如今由swagger2到swagger-bootstrap-ui也是沒有壓力的,基本上參考官方文檔就能弄好了。

目前我應用在我我的的博客項目上,效果如圖:
html

關於如何搭建步驟,我主要是參考官方文檔,我本次寫的就做爲官方文檔的一點補充:前端

1、添加Maven依賴

<dependency>
       <groupId>com.github.xiaoymin</groupId>
       <artifactId>swagger-bootstrap-ui</artifactId>
       <version>1.9.3</version>
</dependency>

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

2、編寫配置類

import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI; 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 @EnableSwaggerBootstrapUI public class SwaggerConfiguration { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.blog.springboot")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("swagger-bootstrap-ui RESTful APIs") .description("swagger-bootstrap-ui") .termsOfServiceUrl("http://www.youcongtech.com") .contact("developer@mail.com") .version("1.1") .build(); } }

3、去下載對應的前端資源

下載地址爲:https://github.com/xiaoymin/Swagger-Bootstrap-UI/tags ,以下圖所示:git

4、下載完畢後解壓並將swagger-bootstrap-ui放到springboot項目職工的src/main/resources目錄下

步驟如圖:
找到這個文件夾
github

並將其遷移到springboot對應的目錄web

5、整個流程完成後,啓動應用,訪問地址爲http://IP:Port//doc.html

參考資料以下:
swagger-bootstrap-ui文檔:http://doc.xiaominfo.com
spring

相關文章
相關標籤/搜索