史上最簡單的Swagger2實現API文件的靜態部署並支援匯出PDF並解決中文亂碼問題...

weixin_34138377發表於2018-09-18
SwaggerAPI

簡單介紹下Swagger2吧
算了不說了。就是個文件框架,具體的網上一大堆介紹

如何使用

  1. 導包
      <dependency>
          <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>
  1. 載入配置類
package com.eliteai.smartiot.config.swagger;

import org.springframework.beans.factory.annotation.Value;
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;

/**
 * Swagger能成為最受歡迎的REST APIs文件生成工具之一，有以下幾個原因：
 * Swagger 可以生成一個具有互動性的API控制檯，開發者可以用來快速學習和嘗試API。
 * Swagger 可以生成客戶端SDK程式碼用於各種不同的平臺上的實現。
 * Swagger 檔案可以在許多不同的平臺上從程式碼註釋中自動生成。
 * Swagger 有一個強大的社群，裡面有許多強悍的貢獻者
 *
 * @author MR.ZHANG
 * @create 2018-09-18 10:06
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    private static final String VERSION = "1.0.0";

    @Value("${swagger.enable}")
    private boolean enableSwagger;
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(enableSwagger)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.eliteai.smartiot.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXXX軟體介面")
                .description("Restful 風格介面")
                //服務條款網址
                //.termsOfServiceUrl("http://xxxx")
                .version(VERSION)
                //.contact(new Contact("wesker", "url", "email"))
                .license("Apache 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
                .build();
    }
}

basePackage是指定掃描的包，這裡要根據實際作修改

package com.eliteai.smartiot.config.swagger;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 配置Swagger的資源對映路徑
 *原有WebMvcConfigurerAdapter已經過時 使用WebMvcConfigurer取代
 * @author MR.ZHANG
 * @create 2018-09-18 10:41
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Value("${swagger.enable}")
    private boolean enableSwagger;

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        if (enableSwagger) {
            registry.addResourceHandler("/js/**").addResourceLocations("classpath:/js/");
            registry.addResourceHandler("swagger-ui.html")
                    .addResourceLocations("classpath:/META-INF/resources/");
            registry.addResourceHandler("/webjars/**")
                    .addResourceLocations("classpath:/META-INF/resources/webjars/");
        }
    }

}

解釋下enableSwagger是多環境配置開關，一般生產環境中不想開啟swagger的uil介面，就可以讓其為false，當然這個得在yml裡增加支援

#----------------swagger配置-----------------------
swagger:
  enable: false
  1. 在Controller裡使用，這裡直接貼程式碼
/**
 * 中央監控中心Controller
 *
 * @author MR.ZHANG
 * @create 2018-09-10 14:22
 */
@Api(value="/central", tags="中央監控中心模組")
@Controller
public class CentralMonitorController extends BaseController {
   @ApiOperation(value="登陸頁面", notes = "中央監控中心登陸介面")
    @GetMapping("/")
    public String adminPage() {
        return "login";
    }

    @ApiOperation(value="管理員登陸", notes = "中央監控中心管理員登陸", produces = "application/json", response = BaseResult.class)
    @ApiResponses({@ApiResponse(code = CommonData.SUCCESS, message = "成功"),
                    @ApiResponse(code = CommonData.ERR_USER_NO_LOGIN, message = "限制登陸"),
                    @ApiResponse(code = CommonData.ERR_APP_INVALID_PWD, message = "賬號或密碼錯誤")
                    })
    @ApiImplicitParams({@ApiImplicitParam(name = "admin", value = "t_user name", required = true, dataType = "String", paramType = "query"),
                        @ApiImplicitParam(name = "pwd", value = "t_user password", required = true, dataType = "String", paramType = "query")})
    @PostMapping("/login")
    @ResponseBody
    public BaseResult login(String admin, String pwd) {
}
  1. 執行專案，瀏覽器輸入http://localhost:8080/swagger-ui.html看看吧

靜態部署

有時候我們想要把文件匯出來給客戶或者其他人用，這時候總不能讓他們去登陸這個地址吧。最好就是像以前我們手寫文件那樣給他們一個doc或者pdf。所以靜態部署這個需求就出來了。

如何部署

1. 引入依賴

        <dependency>
            <groupId>io.github.swagger2markup</groupId>
            <artifactId>swagger2markup</artifactId>
            <version>1.3.1</version>
        </dependency>
        <dependency>
            <groupId>org.asciidoctor</groupId>
            <artifactId>asciidoctorj-pdf</artifactId>
            <version>1.5.0-alpha.10.1</version>
            <scope>test</scope>
        </dependency>

swagger2markup是一個開源的專案，就是用來實現靜態部署的。支援匯出html,markdown,pdf格式文件。詳細可去https://github.com/13001260824/swagger瞭解下
asciidoctorj-pdf是一個將adoc檔案轉pdf的外掛

2. 配置外掛

           <plugin>
                <groupId>io.github.swagger2markup</groupId>
                <artifactId>swagger2markup-maven-plugin</artifactId>
                <version>1.3.1</version>
                <configuration>
                    <swaggerInput>http://localhost:8080/v2/api-docs</swaggerInput>
                    <outputDir>src/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.6</version>
                <configuration>
                    <sourceDirectory>src/docs/asciidoc/generated</sourceDirectory>
                    <outputDirectory>src/docs/asciidoc/html</outputDirectory>
                    <backend>html</backend>
                    <sourceHighlighter>coderay</sourceHighlighter>
                    <attributes>
                        <toc>left</toc>
                    </attributes>
                </configuration>
            </plugin>

看到配置裡有一些路徑，是的那就是aodc和html檔案生成的路徑。給個圖看一下吧


7634890-6d3ef22a25ba7ddf.png
image.png

3. 編寫測試程式，用來生成adoc檔案

package com.eliteai.smartiot;

import io.github.swagger2markup.Swagger2MarkupConfig;
import io.github.swagger2markup.Swagger2MarkupConverter;
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
import io.github.swagger2markup.markup.builder.MarkupLanguage;
import org.asciidoctor.cli.AsciidoctorInvoker;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.net.URL;
import java.nio.file.Paths;

/**
 * @author MR.ZHANG
 * @create 2018-09-18 16:13
 */


@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class DemoApplicationTests {

    @Test
    public void generateAsciiDocs() throws Exception {
        //    輸出Ascii格式
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withGeneratedExamples()
                .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
                .build();

        Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
                .withConfig(config)
                .build()
                .toFile(Paths.get("src/docs/asciidoc/generated/api"));
    }
    @Test
    public void generatePDF() {
        //樣式
        String style = "pdf-style=E:\\themes\\theme.yml";
        //字型
        String fontsdir = "pdf-fontsdir=E:\\fonts";
        //需要指定adoc檔案位置
        String adocPath = "E:\\all.adoc";
        AsciidoctorInvoker.main(new String[]{"-a",style,"-a",fontsdir,"-b","pdf",adocPath});
    }
}

generateAsciiDocs這個測試方法執行後會在src/docs/asciidoc/generated目錄下生成api.adoc檔案

4. 生成HTML文件

asciidoctor:process-asciidoc

7634890-0052bb9dd15f3846.png
image.png

建立好後執行
7634890-ae4f54d25cbf3801.png
image.png

無意外的話會在src/docs/asciidoc/html下生成api.html

5. 生成PDF文件並解決中文亂碼問題

5.1 還記得https://github.com/13001260824/swagger這個地址嗎，進去把這個專案download下來,把目錄下的data目錄拷貝到E盤根目錄下(當然哪都行啦)
5.2 去下載一箇中文字型，字尾是.ttf結尾的，放到data/fonts目錄裡
5.3 複製data/themes/default-theme.yml為theme.yml，開啟theme.yml並搜尋mplus1p開頭的檔名，換成5.2下載的中文字型
5.4 執行測試程式中的generatePDF生成pdf檔案。至此結束!
謝謝觀賞!

參考：
使用Swagger2Markup實現API文件的靜態部署（一）
asciidoctor-pdf中文亂碼問題或顯示不全

相關文章