永中文档在线转换服务Swagger调用说明
永中文档转换服务简介
永中文档在线预览软件(即永中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(); } }
访问Swagger页面
至于具体Controller层的配置,这边就不贴出来了, 直接访问Swagger页面查看——访问 IP+端口+项目名+swagger-ui/index.html
调用get接口测试Swagger页面
选择调用的接口
点击Try it out
执行Execute,查看结果
调用post接口实现PDF文档转换预览
选择复合型中的upload接口,并点击Try it out
上传一个pdf文件
选择对应的转换类型值
执行,选中viewUrl在浏览器中打开
预览
调用post接口实现OFFICE文档加水印
针对office文件(word,excel,ppt),转换类型的值可以使用0
加入一些水印的参数
预览效果
结语
经过上面的简单测试,可以看出,永中的在线预览服务在使用Swagger后,调用接口变得更为简单且方便了。不仅office这种流式文件可以预览,像PDF的版式文件也可以,并且还有加水印、防复制、放下载,限制访问时间与次数问等等功能,更多关于文档转换服务Swagger调用的资料请关注脚本之家其它相关文章!
相关文章
Mybatis-plus获取雪花算法生成的ID并返回生成ID
本文主要介绍了Mybatis-plus获取雪花算法生成的ID并返回生成ID,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2023-09-09SpringBoot使用Redis对用户IP进行接口限流的示例详解
使用接口限流的主要目的在于提高系统的稳定性,防止接口被恶意打击,这篇文章主要介绍了SpringBoot使用Redis对用户IP进行接口限流的示例代码,需要的朋友可以参考下2023-07-07SpringBoot配置lombok与logback过程解析
这篇文章主要介绍了SpringBoot配置lombok与logback过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-05-05
最新评论