永中文档在线转换服务Swagger调用说明

2024-04-02 19:55

短信预约 -IT技能 免费直播动态提醒

永中文档转换服务简介

永中文档在线预览软件（即永中DCS）是永中Office针对政企单位提供的文件预览与文件转换服务，可同时供多个业务系统进行对接和集成，赋能业务系统实现Office文档、PDF、OFD等格式文档的在线预览与文档批量格式转换，支持80多种不同文件格式的文件。

Swagger简介

Swagger 是一个用于生成、描述和调用 Restful 接口的 Web 服务。以前调试接口需要通过postman等工具，并且接口繁多，测试起来很是麻烦，而Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以直接进行接口调用和测试的服务。

永中文档转换服务使用SpringBoot，考虑到SpringBoot可以集成Swagger，直接生成Swagger接口。此外，新版的Swagger3相较于Swagger2，配置更少，使用更加方便，所以目前采用的是Swagger3实现接口页面。

添加依赖

<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: 永中文档转换服务")
                .description("集成DCC,Pdf2Word,CAD等全面转码服务,提供同步,异步,MQ等多种调用方式的转码解决方案。")
                .contact(new Contact("Yozo", "https://www.yozodcs.com/"))
                .version("1.0")
                .build();
    }
}