Spring Boot 2.x（十二）：Swagger2的正確玩法

Ilikewhite 發(fā)布于2019-08-19 10:22 / 2109人閱讀

摘要：簡介簡單的來說，的誕生就是為了解決前后端開發(fā)人員進行交流的時候文檔難以維護的痛點，它可以和我們的程序完美的結(jié)合在一起，并且可以與我們的另一開發(fā)利器來配合使用。

Swagger2簡介

簡單的來說，Swagger2的誕生就是為了解決前后端開發(fā)人員進行交流的時候API文檔難以維護的痛點，它可以和我們的Java程序完美的結(jié)合在一起，并且可以與我們的另一開發(fā)利器Spring Boot來配合使用。

開始使用 第一步：導入POM文件

         
            io.springfox
            springfox-swagger2
            2.9.2
         
        
        
        
            com.github.xiaoymin
            swagger-bootstrap-ui
            1.9.0

#### 第二步：添加配置類

我們需要新增一個Swagger2Config 的配置類：

/**
 *    Swagger2 配置類
 * @author vi    
 * @since 2019/3/6 8:31 PM
 */
@Configuration
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("indi.viyoung.viboot.*"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("viboot-swagger2")    //標題
                .description("Restful-API-Doc")    //描述
                .termsOfServiceUrl("https://www.cnblogs.com/viyoung") //這里配置的是服務網(wǎng)站，我寫的是我的博客園站點~歡迎關注~
                .contact(new Contact("Vi的技術博客", "https://www.cnblogs.com/viyoung", "[email protected]")) // 三個參數(shù)依次是姓名，個人網(wǎng)站，郵箱
                .version("1.0") //版本
                .build();
    }
}

第三步：在啟動類中添加配置

注意一定要記得添加@EnableSwagger2注解

/**
 * @author vi
 * @since 2019/3/6 6:35 PM
 */
@SpringBootApplication
@ComponentScan(value = "indi.viyoung.viboot.*")
@MapperScan(value = "indi.viyoung.viboot.swagger2.mapper")
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class ViBootSwaggerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ViBootSwaggerApplication.class, args);
    }
}

第四步：通過注解來完成API文檔

1. @Api

注解名稱	注解屬性	作用域	屬性作用
@Api	tags	類	說明該類的作用
	value	類	說明該類的作用

舉個

文章版權歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/75909.html

SpringBoot 2.X Kotlin與Swagger2生成API文檔

摘要：再通過函數(shù)創(chuàng)建的之后，用來創(chuàng)建該的基本信息這些基本信息會展現(xiàn)在文檔頁面中。函數(shù)返回一個實例用來控制哪些接口暴露給來展現(xiàn)，本例采用指定掃描的包路徑來定義，會掃描該包下所有定義的，并產(chǎn)生文檔內(nèi)容除了被指定的請求。 showImg(http://download.qfeoo.com/kotlin_springboot_logo.png); 這里有個地方需要注意，在測試WebFlux集成Swa...

cyqian 2019-08-16 16:38 評論0 收藏0
Java | Spring Boot Swagger2 集成REST ful API 生成接口文檔

摘要：集成生成接口文檔原文簡介由于的特性，用來開發(fā)變得非常容易，并且結(jié)合來自動生成文檔變得方便快捷。使用生成，我們可以得到交互式文檔。聽過與的結(jié)合，生成更加完備的文檔。接下來將基于與搭建完整的文檔系統(tǒng)。 Spring Boot Swagger2 集成REST ful API 生成接口文檔原文簡介由于Spring Boot 的特性，用來開發(fā) REST ful 變得非常容易，并且結(jié)合 Sw...

joyvw 2019-08-16 10:56 評論0 收藏0
Gradle環(huán)境下導出Swagger為PDF

摘要：沒錯，不支持，從導出的文檔也可以看到，部分中文無法顯示，目前我也尚未找到是否有配置可以實現(xiàn)這個功能。相對前面的方式，使用起來更加簡單，也可以修改配置輸出中文。更多精彩博文，歡迎訪問我的個人博客說明我個人是一直使用Swagger作為接口文檔的說明的。但是由于在一些情況下，接口文檔說明需要以文件的形式交付出去，如果再重新寫一份文檔難免有些麻煩。于是在網(wǎng)上看到了Swagger2Mar...

OnlyMyRailgun 2019-08-16 18:23 評論0 收藏0
Spring Boot中使用Swagger2構(gòu)建API文檔

摘要：使用生成，我們可以得到交互式文檔，自動生成代碼的以及的發(fā)現(xiàn)特性等。方法指定掃描的包會生成文檔默認是顯示所有接口可以用注解標識該接口不顯示。程序員都很希望別人能寫技術文檔，自己卻很不愿意寫文檔。因為接口數(shù)量繁多,并且充滿業(yè)務細節(jié),寫文檔需要花大量的時間去處理格式排版,代碼修改后還需要同步修改文檔,經(jīng)常因為項目時間緊等原因?qū)е挛臋n滯后于代碼，接口調(diào)用方的抱怨聲不絕于耳。而程序員是最擅長偷...

taohonghui 2019-08-15 11:09 評論0 收藏0
SpringBoot 實戰(zhàn) (五) | 集成 Swagger2 構(gòu)建強大的 RESTful API

摘要：今天給你們帶來集成的教程。接口返回結(jié)果不明確。這些痛點在前后端分離的大型項目上顯得尤為煩躁。接口返回結(jié)果非常明確，包括數(shù)據(jù)類型，狀態(tài)碼，錯誤信息等。生成后的文件依賴如下這里使用的是的版本。另外，關注之后在發(fā)送可領取免費學習資料。微信公眾號：一個優(yōu)秀的廢人如有問題或建議，請后臺留言，我會盡力解決你的問題。前言快過年了，不知道你們啥時候放年假，忙不忙。反正我是挺閑的，所以有時間寫 b...

Rindia 2019-08-16 15:12 評論0 收藏0