快捷導(dǎo)航

永中文檔在線轉(zhuǎn)換服務(wù)Swagger調(diào)用說明

更新時(shí)間：2022年06月09日 11:21:49 作者：yozodcs

這篇文章主要為大家介紹了永中文檔在線轉(zhuǎn)換服務(wù)Swagger調(diào)用說明，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

永中文檔轉(zhuǎn)換服務(wù)簡介

永中文檔在線預(yù)覽軟件（即永中DCS）是永中Office針對政企單位提供的文件預(yù)覽與文件轉(zhuǎn)換服務(wù)，可同時(shí)供多個(gè)業(yè)務(wù)系統(tǒng)進(jìn)行對接和集成，賦能業(yè)務(wù)系統(tǒng)實(shí)現(xiàn)Office文檔、PDF、OFD等格式文檔的在線預(yù)覽與文檔批量格式轉(zhuǎn)換，支持80多種不同文件格式的文件。

Swagger簡介

Swagger 是一個(gè)用于生成、描述和調(diào)用 Restful 接口的 Web 服務(wù)。以前調(diào)試接口需要通過postman等工具，并且接口繁多，測試起來很是麻煩，而Swagger 就是將項(xiàng)目中所有（想要暴露的）接口展現(xiàn)在頁面上，并且可以直接進(jìn)行接口調(diào)用和測試的服務(wù)。

永中文檔轉(zhuǎn)換服務(wù)使用SpringBoot，考慮到SpringBoot可以集成Swagger，直接生成Swagger接口。此外，新版的Swagger3相較于Swagger2，配置更少，使用更加方便，所以目前采用的是Swagger3實(shí)現(xiàn)接口頁面。

添加依賴

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-boot-starter</artifactId>
  <version>3.0.0</version>
</dependency>

加入@EnableOpenApi注解

@EnableOpenApi
@SpringBootApplication
public class Swagger3DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(Swagger3DemoApplication.class, args);
    }
}

配置Swagger

@Configuration
public class Swagger3Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
             .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("FcsCloud: 永中文檔轉(zhuǎn)換服務(wù)")
                .description("集成DCC,Pdf2Word,CAD等全面轉(zhuǎn)碼服務(wù),提供同步,異步,MQ等多種調(diào)用方式的轉(zhuǎn)碼解決方案。")
                .contact(new Contact("Yozo", "https://www.yozodcs.com/"))
                .version("1.0")
                .build();
    }
}

訪問Swagger頁面

至于具體Controller層的配置，這邊就不貼出來了，直接訪問Swagger頁面查看——訪問 IP+端口+項(xiàng)目名+swagger-ui/index.html

調(diào)用get接口測試Swagger頁面

選擇調(diào)用的接口

點(diǎn)擊Try it out

執(zhí)行Execute，查看結(jié)果

調(diào)用post接口實(shí)現(xiàn)PDF文檔轉(zhuǎn)換預(yù)覽

選擇復(fù)合型中的upload接口，并點(diǎn)擊Try it out

上傳一個(gè)pdf文件

選擇對應(yīng)的轉(zhuǎn)換類型值

執(zhí)行，選中viewUrl在瀏覽器中打開

預(yù)覽

調(diào)用post接口實(shí)現(xiàn)OFFICE文檔加水印

針對office文件（word，excel，ppt)，轉(zhuǎn)換類型的值可以使用0

加入一些水印的參數(shù)

預(yù)覽效果

結(jié)語

經(jīng)過上面的簡單測試，可以看出，永中的在線預(yù)覽服務(wù)在使用Swagger后，調(diào)用接口變得更為簡單且方便了。不僅office這種流式文件可以預(yù)覽，像PDF的版式文件也可以，并且還有加水印、防復(fù)制、放下載，限制訪問時(shí)間與次數(shù)問等等功能，更多關(guān)于文檔轉(zhuǎn)換服務(wù)Swagger調(diào)用的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: