coding
coding喵的gravatar頭像
coding喵2019-08-21 16:54:47
springboot集成SwaggerBootstrapUI文檔

1.導包

由于是基于swagger的需要先引入swagger包

       <!--引入swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

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

 

2.新建Swagger配置類

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @Description  Swagger文檔
 * @Author thcoding
 * @Date 2019/5/23
 **/
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfiguration {


    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxx.group"))
                .paths(PathSelectors.any())
                .build();
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xxxxxxx接口管理文檔")
                .description("xxxx接口管理文檔")
                .termsOfServiceUrl("http://127.0.0.1:8080/")
                .contact(new Contact("coding喵","","[email protected]"))
                .version("1.0")
                .build();
    }

}

 

- @Configuration:聲明配置文件
- @EnableSwagger2:開啟Swagger2
- @EnableSwaggerBootstrapUI:開啟SwaggerBootstrapUI

 

- basePackage:聲明主包
- title:文檔名稱
- 團隊訪問網址:termsOfServiceUrl
- 賬號信息:Contact
- version:版本

 

3.常用注解

@ApiModel(value = "xxx",description = "xxx")
- 用于實體類上,value=實體類名稱,description用于描述實體類

代碼示例:

springboot集成SwaggerBootstrapUI文檔

 

@ApiModelProperty(value = "xx")
- 用于描述字段

代碼示例:

springboot集成SwaggerBootstrapUI文檔

 

@Api(tags = "xxx")
- 用于描述控制器Controller,即xx管理

代碼示例:

springboot集成SwaggerBootstrapUI文檔

 

@ApiOperation(value="xx",notes = "xx")
- 用于描述控制器內單個方法,value=方法名稱,notes描述方法

代碼示例:

springboot集成SwaggerBootstrapUI文檔

 

4.文檔訪問

在瀏覽器輸入:http://${host}:${port}/${項目服務主路徑}/doc.html

 

5.文檔效果圖:

5.1主頁

springboot集成SwaggerBootstrapUI文檔

 

5.2實體對象展示

springboot集成SwaggerBootstrapUI文檔

 

5.3接口出參及入參展示

springboot集成SwaggerBootstrapUI文檔

 

5.4接口出參及入參展示

springboot集成SwaggerBootstrapUI文檔

 

5.5自帶接口調試springboot集成SwaggerBootstrapUI文檔

 

6.一些說明

SwaggerBootstrapUI只是基于Swagger,用于文檔頁面美化,方便前后端查看的工具。
我在這里提供的注解不多,主要是我認為代碼中還是少寫點漢字,或是對邏輯無用的代碼,以免造成代碼冗余,這里的注解是我自己準備常用的注解。
對于該ui,我自己依然有些未解決的問題,比如,生產環境中如何限制對文檔的訪問?這個我看了官方文檔,寫了配置也沒起作用,暫時也無時間去深究。
由于版本的問題,有些地方可能會不太一樣,比如文檔訪問路徑,有的版本是http://${host}:${port}/doc.html
后續遇到相關問題我會陸續補充

 

 

 


打賞

已有1人打賞

最代碼官方的gravatar頭像

分享到:

最近瀏覽
a694110193 LV210月14日
星星星星
xxljxgz LV2110月14日
太陽月亮星星
Jason_zqw LV310月14日
星星星星星星
東北人 LV1110月11日
月亮月亮星星星星星星
暫無貢獻等級
kai_xixi10月9日
暫無貢獻等級
371652929 LV510月8日
月亮星星
唔知叫咩名 LV2010月5日
太陽月亮
落軒昂 LV109月30日
月亮月亮星星星星
靈依ziNing LV49月29日
月亮
頂部客服微信二維碼底部
>掃描二維碼關注最代碼為好友掃描二維碼關注最代碼為好友
谁有北京pk10计划群