永中文档在线转换服务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调用的资料请关注猪先飞其它相关文章！
原文出处：https://blog.csdn.net/yozodcs/article/details/122553201
相关文章
- 这篇文章主要介绍了Swagger中@ApiIgnore注解的使用，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教...2021-10-21
- 这篇文章主要介绍了c# webapi 配置swagger的方法，文中示例代码非常详细，帮助大家更好的理解和学习，感兴趣的朋友可以了解下...2020-07-09
- 这篇文章主要介绍了Swagger2匹配多个controller代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-19
- 这篇文章介绍了.NET的动态编译与WS服务调用详解，有需要的朋友可以参考一下，希望对你有所帮助...2021-09-22
- 这篇文章主要介绍了关于springboot整合swagger问题及解决方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2021-04-20
- 这篇文章主要介绍了Spring集成Swagger常见错误及解决办法，帮助大家更好的理解和学习使用Spring，感兴趣的朋友可以了解下...2021-05-03
手把手教你SpringBoot快速集成Swagger的配置过程
这篇文章主要介绍了手把手教你SpringBoot快速集成Swagger的配置过程,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下...2021-02-21- 这篇文章主要介绍了基于swagger测试List类型参数过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...2020-09-19
- 今天给大家带来的是关于Java的相关知识,文章围绕着java如何集成swagger组件展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下...2021-06-22
- 这篇文章主要介绍了swagger如何返回map字段注释的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教...2021-07-03
- 这篇文章主要介绍了ASP.NetCore使用Swagger实战，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧...2020-11-11
SpringBoot如何优雅的整合Swagger Api自动生成文档
在多人协作的开发过程中,API文档不仅可以减少等待,也能保证开发的持续进行,这篇文章主要给大家介绍了关于SpringBoot如何优雅的整合Swagger Api自动生成文档的相关资料,需要的朋友可以参考下...2021-07-08- 这篇文章主要介绍了Java集成swagger文档组件,通过详细的图文介绍和代码分析展示,从头展开说明详细的过程,希望对你的开发有所帮助...2021-06-29
- 关于spring-cloud的服务调用，我们首先需要了解它的两个核心组件Ribbon和Feign。接下来通过本文给大家详细介绍spring-cloud服务之间的调用之ribbon，感兴趣的朋友一起看看吧...2021-08-03
Asp.net core WebApi 使用Swagger生成帮助页实例
本篇文章主要介绍了Asp.net core WebApi 使用Swagger生成帮助页实例，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。...2021-09-22Asp.Net Core WebAPI使用Swagger时API隐藏和分组详解
这篇文章主要给大家介绍了关于Asp.Net Core WebAPI使用Swagger时API隐藏和分组的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Asp.Net Core具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧...2021-09-22Asp.Net Core使用swagger生成api文档的完整步骤
这篇文章主要给大家介绍了关于Asp.Net Core使用swagger生成api文档的完整步骤，文中通过示例代码介绍的非常详细，对大家学习或者使用Asp.Net Core具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧...2021-09-22- Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful风格的Web服务,这篇文章主要给大家介绍了关于Spring Boot中如何使用Swagger的相关资料,需要的朋友可以参考下...2021-08-06
.NET Core利用swagger进行API接口文档管理的方法详解
这篇文章主要给大家介绍了关于.NET Core利用swagger进行API接口文档管理的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。...2021-09-22- 本文将介绍如何使用Swagger来上传文件。本文分步骤给大家介绍的非常详细，感兴趣的朋友跟随脚本之家小编一起学习吧...2021-09-22