Spring Boot 2.X(十五)：整合 Swagger2 開發 API 文件（線上+離線）

阿新 • • 發佈：2019-11-06

前言

相信很多後端開發在專案中都會碰到要寫 api 文件，不管是給前端、移動端等提供更好的對接，還是以後為了以後交接方便，都會要求寫 api 文件。

而手寫 api 文件的話有諸多痛點：

文件更新的時候，需要再次傳送給對接人
介面太對，手寫文件很難管理
介面返回的結果不明確
不能直接線上測試介面，通常需要使用工具，如 postman 等

Swagger 就很好的解決了這個問題。

Swagger 簡介

Swagger 是一個規範和完整的框架，用於生成、描述、呼叫和視覺化 RESTful 風格的 Web 服務。總體目標是使客戶端和檔案系統作為伺服器以同樣的速度來更新。檔案的方法，引數和模型緊密整合到伺服器端的程式碼，允許API來始終保持同步。

官網：https://swagger.io

Swagger 使用

1.相關依賴

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

2.Swagger 配置類

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(buildApiInf()) //將api的元資訊設定為包含在json resourcelisting響應中
        //.host("127.0.0.1:8080") //設定ip和埠，或者域名
        .select()  //啟動用於api選擇的生成器
        //.apis(RequestHandlerSelectors.any())
        .apis(RequestHandlerSelectors.basePackage("cn.zwqh.springboot.controller"))//指定controller路徑
        .paths(PathSelectors.any()).build();
    }

    private ApiInfo buildApiInf() {
        
        Contact contact=new Contact("朝霧輕寒","https://www.zwqh.top/","[email protected]");
        return new ApiInfoBuilder()
        .title("Swagger Demo Restful API Docs")//文件標題
        .description("Swagger 示例 Restful Api 文件")//文件描述
        .contact(contact)//聯絡人
        .version("1.0")//版本號
        //.license("")//更新此API的許可證資訊
        //.licenseUrl("")//更新此API的許可證Url
        //.termsOfServiceUrl("")//更新服務條款URL
        .build();

    }
}

3.Spring MVC 相關配置

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
    /**
     * 靜態資源配置(預設)
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");// 靜態資源路徑
        registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
        super.addResourceHandlers(registry);
    }


}

如果不新增此靜態資源配置會報錯，找不到相關路徑

4.Model 中使用 Swagger 註解

@ApiModel(value = "UserEntity", description = "使用者物件")
public class UserEntity implements Serializable{

    /**
     * 
     */
    private static final long serialVersionUID = 5237730257103305078L;
    @ApiModelProperty(value ="使用者id",name="id",dataType="Long",required = false,example = "1",hidden = false )
    private Long id;
    @ApiModelProperty(value ="使用者名稱",name="userName",dataType="String",required = false,example = "關羽" )
    private String userName;
    @ApiModelProperty(value ="使用者性別",name="userSex",dataType="String",required = false,example = "男" )
    private String userSex;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getUserSex() {
        return userSex;
    }

    public void setUserSex(String userSex) {
        this.userSex = userSex;
    }

}

5. Controller 中使用 Swagger 註解


@RestController
@RequestMapping("/api")
@Api(tags = { "介面分組1", "介面分組2" })
public class ApiController {

    @Autowired
    private UserDao userDao;

    @GetMapping("/getAllUser")
    @ApiOperation(value = "獲取所有使用者", notes = "", httpMethod = "GET", tags = "介面分組3")
    public List<UserEntity> getAll() {
        return userDao.getAll();
    }

    @GetMapping("/getUserById")
    @ApiOperation(value = "根據id獲取使用者", notes = "id必傳", httpMethod = "GET")
    @ApiImplicitParam(name = "id", value = "使用者id",example = "1", required = true, dataType = "long", paramType = "query")
    public UserEntity getOne(Long id) {
        return userDao.getOne(id);
    }

    @PostMapping("/getUserByNameAndSex")
    @ApiOperation(value = "根據name和sex獲取使用者", notes = "", httpMethod = "POST")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userName", value = "使用者名稱", example = "關羽", required = true, dataType = "string", paramType = "query"),
            @ApiImplicitParam(name = "userSex", value = "使用者性別", example = "男", required = true, dataType = "string", paramType = "query") })
    public UserEntity getUserByNameAndSex(String userName, String userSex) {
        return userDao.getUserByNameAndSex(userName, userSex);
    }

    @PostMapping("/insertUser")
    @ApiOperation(value = "新增使用者", notes = "傳json，資料放body", httpMethod = "POST")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "body", value = "使用者物件json", example = "{userName:'朝霧輕寒',userSex:'男'}", required = true) })
    public String insertUser(@RequestBody String body) {
        System.out.println(body);
        UserEntity user = JSON.parseObject(body, UserEntity.class);
        userDao.insertUser(user);
        return "{code:0,msg:'success'}";
    }

    @PostMapping("/updateUser")
    @ApiOperation(value = "修改使用者", notes = "傳json，資料放body", httpMethod = "POST")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "body", value = "使用者物件json", example = "{id:23,userName:'朝霧輕寒',userSex:'女'}", required = true) })
    public String updateUser(@RequestBody String body) {
        System.out.println(body);
        UserEntity user = JSON.parseObject(body, UserEntity.class);
        userDao.updateUser(user);
        return "{code:0,msg:'success'}";
    }

    @PostMapping("/deleteUser")
    @ApiOperation(value = "刪除使用者", notes = "id必傳", httpMethod = "POST")
    public String deleteUser(@ApiParam(name = "id", value = "使用者id", required = true) Long id) {
        userDao.deleteUser(id);
        return "{code:0,msg:'success'}";
    }
}

5.測試

訪問 http://127.0.0.1:8080/swagger-ui.html 進行介面線上測試

Swagger 常用註解

1.@Api

用於類，表示標識這個類是swagger的資源。屬性如下：

tags 表示說明，tags如果有多個值，會生成多個列表
value 表示說明，可以使用tags替代

2.@ApiOperation

用於方法，表示一個http請求的操作。屬性如下：

value 用於方法描述
notes 用於提示內容
tags 用於API文件控制的標記列表，視情況而用，可以進行獨立分組

3.@ApiParam

用於方法、引數、欄位說明；表示對引數的新增元資料。

name 引數名
value 引數說明
required 是否必填

4.@ApiModel

用於類，表示對類進行說明，用於引數用實體類接受。

value 物件名
description 描述

5.@ApiModelProperty

用於方法、欄位，表示對model屬性的說明或者資料操作更改。

value 欄位說明
name 重寫屬性名
dataType 重寫屬性資料型別
required 是否必填
example 舉例說明
hidden 隱藏

6.@ApiIgnore

用於類、方法、方法引數，表示這個方法或者類被忽略，不在swagger-ui.html上顯示。

7.@ApiImplicitParam

用於方法，表示單獨的請求引數。

name 引數名
value 引數說明
dataType 資料型別
paramType 引數型別
example 舉例說明

8.@ApiImplicitParams

用於方法，包含多個 @ApiImplicitParam。

9.@ApiResponses @ApiResponse

用於類或者方法，描述操作的可能響應。

code 響應的HTTP狀態程式碼
message 響應附帶的可讀訊息

10.@ResponseHeader

用於方法，響應頭設定。

name 響應頭名稱
description 頭描述
response 預設響應類 void
responseContainer 參考ApiOperation中配置

Swagger 匯出離線 api 文件

1.匯出 AsciiDocs、Markdown、Confluence 格式文件

新增依賴

<!-- swagger2markup 相關依賴 -->
        <dependency>
            <groupId>io.github.swagger2markup</groupId>
            <artifactId>swagger2markup</artifactId>
            <version>1.3.3</version>
        </dependency>

轉換工具類

public class SwaggerUtils {

    private static final String url = "http://127.0.0.1:8080/v2/api-docs";
    /**
     * 生成AsciiDocs格式文件
     * @throws MalformedURLException
     */
    public static void generateAsciiDocs() throws MalformedURLException {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema().build();

        Swagger2MarkupConverter.from(new URL(url))
                .withConfig(config)
                .build()
                .toFolder(Paths.get("./docs/asciidoc/generated"));
    }
    /**
     * 生成AsciiDocs格式文件,並彙總成一個檔案
     * @throws MalformedURLException
     */
    public static void generateAsciiDocsToFile() throws MalformedURLException {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL(url))
                .withConfig(config)
                .build()
                .toFile(Paths.get("./docs/asciidoc/generated/all"));
    }
    
    /**
     * 生成Markdown格式文件
     * @throws MalformedURLException
     */
    public static void generateMarkdownDocs() throws MalformedURLException {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.MARKDOWN)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL(url))
                .withConfig(config)
                .build()
                .toFolder(Paths.get("./docs/markdown/generated"));
    }
    /**
     * 生成Markdown格式文件,並彙總成一個檔案
     * @throws MalformedURLException
     */
    public static void generateMarkdownDocsToFile() throws MalformedURLException {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.MARKDOWN)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL(url))
                .withConfig(config)
                .build()
                .toFile(Paths.get("./docs/markdown/generated/all"));
    }
    
    /**
     * 生成Confluence格式文件
     * @throws MalformedURLException
     */
    public static void generateConfluenceDocs() throws MalformedURLException {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.CONFLUENCE_MARKUP)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL(url))
                .withConfig(config)
                .build()
                .toFolder(Paths.get("./docs/confluence/generated"));
    }
    
    /**
     * 生成Confluence格式文件,並彙總成一個檔案
     * @throws MalformedURLException
     */
    public static void generateConfluenceDocsToFile() throws MalformedURLException {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.CONFLUENCE_MARKUP)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL(url))
                .withConfig(config)
                .build()
                .toFile(Paths.get("./docs/confluence/generated/all"));
    }
    
    
}

使用測試 Controller

@RestController
@RequestMapping("/export")
@ApiIgnore
public class ExportController {

    
    @RequestMapping("/ascii")
    public String exportAscii() throws MalformedURLException{
        SwaggerUtils.generateAsciiDocs();
        return "success";
    }
    
    @RequestMapping("/asciiToFile")
    public String asciiToFile() throws MalformedURLException{
        SwaggerUtils.generateAsciiDocsToFile();
        return "success";
    }
    
    @RequestMapping("/markdown")
    public String exportMarkdown() throws MalformedURLException{
        SwaggerUtils.generateMarkdownDocs();
        return "success";
    }
    
    @RequestMapping("/markdownToFile")
    public String exportMarkdownToFile() throws MalformedURLException{
        SwaggerUtils.generateMarkdownDocsToFile();
        return "success";
    }
    
    @RequestMapping("/confluence")
    public String confluence() throws MalformedURLException{
        SwaggerUtils.generateConfluenceDocs();
        return "success";
    }
    
    @RequestMapping("/confluenceToFile")
    public String confluenceToFile() throws MalformedURLException{
        SwaggerUtils.generateConfluenceDocsToFile();
        return "success";
    }
}

2.匯出 html、pdf、xml 格式

新增依賴

<!--離線文件 -->
        <dependency>
            <groupId>org.springframework.restdocs</groupId>
            <artifactId>spring-restdocs-mockmvc</artifactId>
            <scope>test</scope>
        </dependency>
        <!--springfox-staticdocs 生成靜態文件 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-staticdocs</artifactId>
            <version>2.6.1</version>
        </dependency>

<build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
                <plugin>
                    <groupId>io.github.swagger2markup</groupId>
                    <artifactId>swagger2markup-maven-plugin</artifactId>
                    <version>1.3.1</version>
                    <configuration>
                        <swaggerInput>http://127.0.0.1:8080/v2/api-docs</swaggerInput>
                        <outputDir>./docs/asciidoc/generated</outputDir>
                        <config>
                            <swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>
                        </config>
                    </configuration>
                </plugin>
                <plugin>
                    <groupId>org.asciidoctor</groupId>
                    <artifactId>asciidoctor-maven-plugin</artifactId>
                    <version>1.5.3</version>
                    <!-- <version>2.0.0-RC.1</version> -->
                    <!-- Include Asciidoctor PDF for pdf generation -->
                    <dependencies>
                        <dependency>
                            <groupId>org.asciidoctor</groupId>
                            <artifactId>asciidoctorj-pdf</artifactId>
                            <version>1.5.0-alpha.10.1</version>
                        </dependency>
                        <dependency>
                            <groupId>org.jruby</groupId>
                            <artifactId>jruby-complete</artifactId>
                            <version>1.7.21</version>
                        </dependency>
                    </dependencies>
                    <configuration>
                        <sourceDirectory>./docs/asciidoc/generated</sourceDirectory>
                        <outputDirectory>./docs/asciidoc/html</outputDirectory> 
                        <backend>html</backend>
                        <!-- <outputDirectory>./docs/asciidoc/pdf</outputDirectory> 
                        <backend>pdf</backend> -->
                        <headerFooter>true</headerFooter> 
                        <doctype>book</doctype> 
                        <sourceHighlighter>coderay</sourceHighlighter>
                        <attributes>
                            <!-- 選單欄在左邊 -->
                            <toc>left</toc>
                            <!-- 多標題排列 -->
                            <toclevels>3</toclevels>
                            <!-- 自動打數字序號 -->
                            <sectnums>true</sectnums>
                        </attributes>
                    </configuration>                    
                </plugin>
            </plugins>
        </pluginManagement>

    </build>

可以修改此處 html 和 pdf，通過 mvn asciidoctor:process-asciidoc 可以匯出相應格式檔案

<outputDirectory>./docs/asciidoc/html</outputDirectory> 
                        <backend>html</backend>

執行 mvn asciidoctor:process-asciidoc 後再執行 mvn generate-resources，可在 targt/generated-docs 目錄下生成 xml 格式檔案。

完整程式碼

github

碼

Spring Boot 2.X(十五)：整合 Swagger2 開發 API 文件（線上+離線）

前言相信很多後端開發在專案中都會碰到要寫 api 文件，不管是給前端、移動端等提供更好的對接，還是以後為了以後交接方便，都會要求寫 api 文件。而手寫 api 文件的話有諸多痛點：文件更新的時候，需要再次傳送給對接人介面太對，手寫文件很難管理介面返回的結果不明確不能直接線上測試介面，通常需要使

Spring Boot 2.X(十八)：整合 Spring Security-登入認證和許可權控制

前言在企業專案開發中，對系統的安全和許可權控制往往是必需的，常見的安全框架有 Spring Security、Apache Shiro 等。本文主要簡單介紹一下 Spring Security，再通過 Spring Boot 整合開一個簡單的示例。 Spring Security 什麼是 Spring Se

Spring Boot 2.x 基礎案例：整合Dubbo 2.7.3+Nacos1.1.3（最新版）

1、概述本文將介紹如何基於Spring Boot 2.x的版本，通過Nacos作為配置與註冊中心，實現Dubbo服務的註冊與消費。整合元件的版本說明： Spring Boot 2.1.9 Dubbo 2.7.3 Nacos 1.1.3 本文的亮點： 1.採用yml方式進行dubbo的配置。 2.

Spring Boot 2.x 基礎案例：整合Dubbo 2.7.3+Nacos1.1.3（配置中心）

本文原創首發於公眾號：Java技術乾貨 1、概述本文將Nacos作為配置中心，實現配置外部化，動態更新。這樣做的優點：不需要重啟應用，便可以動態更新應用裡的配置資訊。在如今流行的微服務應用下，將應用的配置統一管理，顯得尤為重要。上一篇寫了《Spring Boot 2.x 基礎案例：整合Dubbo

Spring Boot 2.X(十一)：全域性異常處理

前言在 Java Web 系統開發中，不管是 Controller 層、Service 層還是 Dao 層，都有可能丟擲異常。如果在每個方法中加上各種 try catch 的異常處理程式碼，那樣會使程式碼非常繁瑣。在Spring MVC 中，我們可以將所有型別的異常處理從各個單獨的方法中解耦出來，進行異常資

Spring Boot 2.X(十二)：定時任務

簡介定時任務是後端開發中常見的需求，主要應用場景有定期資料報表、定時訊息通知、非同步的後臺業務邏輯處理、日誌分析處理、垃圾資料清理、定時更新快取等等。 Spring Boot 集成了一整套的定時任務工具，讓我們專注於完成邏輯，剩下的基礎排程工作將自動完成。通用實現方式實現方式描述 jav

Spring Boot 2.X(十四)：日誌功能 Logback

Logback 簡介 Logback 是由 SLF4J 作者開發的新一代日誌框架，用於替代 log4j。主要特點是效率更高，架構設計夠通用，適用於不同的環境。 Logback 分為三個模組：logback-core，logback-classic和logback-access。 logback-core 模

Spring Boot 2.X(十六)：應用監控之 Spring Boot Actuator 使用及配置

Actuator 簡介 Actuator 是 Spring Boot 提供的對應用系統的自省和監控功能。通過 Actuator，可以使用資料化的指標去度量應用的執行情況，比如檢視伺服器的磁碟、記憶體、CPU等資訊，系統的執行緒、gc、執行狀態等等。 Actuator 通常通過使用 HTTP 和 JMX 來管理

Spring Boot 2.x基礎教程：使用Swagger2構建強大的API文件

隨著前後端分離架構和微服務架構的流行，我們使用Spring Boot來構建RESTful API專案的場景越來越多。通常我們的一個RESTful API就有可能要服務於多個不同的開發人員或開發團隊：IOS開發、Android開發、Web開發甚至其他的後端服務等。為了減少與其他團隊平時開發期間的頻繁溝通成本，傳

Spring Boot 2.X(十)：自定義註冊 Servlet、Filter、Listener

前言在 Spring Boot 中已經移除了 web.xml 檔案，如果需要註冊新增 Servlet、Filter、Listener 為 Spring Bean，在 Spring Boot 中有兩種方式：使用 Servlet 3.0 API 的註解 @WebServlet、@WebFilter、@Lis

Spring Boot 2.x基礎教程：快速入門

開發十年，就只剩下這套架構體系了！ >>>

Spring Boot 2.x基礎教程：工程結構推薦

Spring Boot框架本身並沒有對工程結構有特別的要求，但是按照最佳實踐的工程結構可以幫助我們減少可能會遇見的坑，尤其是Spr

Spring Boot 2.x基礎教程：構建RESTful API與單元測試

首先，回顧並詳細說明一下在快速入門中使用的@Controller、@RestController、@RequestMapping註

Spring Boot 2.x基礎教程：JSR-303實現請求引數校驗

請求引數的校驗是很多新手開發非常容易犯錯，或存在較多改進點的常見場景。比較常見的問題主要表現在以下幾個方面：僅依靠前端框架解決引數校驗，缺失服務端的校驗。這種情況常見於需要同時開發前後端的時候，雖然程式的正常使用不會有問題，但是開發者忽略了非正常操作。比如繞過前端程式，直接模擬客戶端請求，這時候就會突然在

Spring Boot 2.x基礎教程：Swagger介面分類與各元素排序問題詳解

之前通過Spring Boot 2.x基礎教程：使用Swagger2構建強大的API文件一文，我們學習瞭如何使用Swagger為Spring Boot專案自動生成API文件，有不少使用者留言問了關於文件內容的組織以及排序問題。所以，就特別開一篇詳細說說Swagger中文件內容如何來組織以及其中各個元素如何控制

Spring Boot 2.x基礎教程：Swagger靜態文件的生成

前言通過之前的兩篇關於Swagger入門以及具體使用細節的介紹之後，我們已經能夠輕鬆地為Spring MVC的Web專案自動構建出API文件了。如果您還不熟悉這塊，可以先閱讀： Spring Boot 2.x基礎教程：使用Swagger2構建強大的API文件 Spring Boot 2.x基礎教程：Swa

Spring Boot 2.x基礎教程：使用JdbcTemplate訪問MySQL資料庫

在第2章節中，我們介紹瞭如何通過Spring Boot來實現HTTP介面，以及圍繞HTTP介面相關的單元測試、文件生成等實用技能。但是，這些內容還不足以幫助我們構建一個動態應用的服務端程式。不論我們是要做App、小程式、還是傳統的Web站點，對於使用者的資訊、相關業務的內容，通常都需要對其進行儲存，而不是像第

Spring Boot 2.x基礎教程：預設資料來源Hikari的配置詳解

通過上一節的學習，我們已經學會如何應用Spring中的JdbcTemplate來完成對MySQL的資料庫讀寫操作。接下來通過本篇文章，重點說說在訪問資料庫過程中的一個重要概念：資料來源（Data Source），以及Spring Boot中對資料來源的建立與配置。基本概念在開始說明Spring Boot中

Spring Boot 2.x基礎教程：使用國產資料庫連線池Druid

上一節，我們介紹了Spring Boot在JDBC模組中自動化配置使用的預設資料來源HikariCP。接下來這一節，我們將介紹另外一個被廣泛應用的開源資料來源：Druid。 Druid是由阿里巴巴資料庫事業部出品的開源專案。它除了是一個高效能資料庫連線池之外，更是一個自帶監控的資料庫連線池。雖然HikariC

Spring Boot 2.x基礎教程：使用Spring Data JPA訪問MySQL

在資料訪問這章的第一篇文章《Spring中使用JdbcTemplate訪問資料庫》中，我們已經介紹瞭如何使用Spring Boot中最基本的jdbc模組來實現關係型資料庫的資料讀寫操作。那麼結合Web開發一章的內容，我們就可以利用JDBC模組與Web模組的功能，綜合著使用來完成一個適用於很多簡單應用場景的後

Spring Boot 2.X(十五)：整合 Swagger2 開發 API 文件（線上+離線）

前言

Swagger 簡介

Swagger 使用

1.相關依賴

2.Swagger 配置類

3.Spring MVC 相關配置

4.Model 中使用 Swagger 註解

5. Controller 中使用 Swagger 註解

5.測試

Swagger 常用註解

1.@Api

2.@ApiOperation

3.@ApiParam

4.@ApiModel

5.@ApiModelProperty

6.@ApiIgnore

7.@ApiImplicitParam

8.@ApiImplicitParams

9.@ApiResponses @ApiResponse

10.@ResponseHeader

Swagger 匯出離線 api 文件

1.匯出 AsciiDocs、Markdown、Confluence 格式文件

2.匯出 html、pdf、xml 格式

完整程式碼

相關推薦