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

目录
  • 永中文档转换服务简介
  • Swagger简介
    • 添加依赖
    • 配置Swagger
    • 访问Swagger页面
    • 调用get接口测试Swagger页面
    • 调用post接口实现PDF文档转换预览
    • 调用post接口实现OFFICE文档加水印
  • 结语

永中文档转换服务简介

永中文档在线预览软件（即永中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调用的资料请关注我们其它相关文章！

赞 (0)

相关推荐

  • 解决swagger2.9.2接口文档显示的问题

    解决swagger2.9.2接口文档显示的问题

    swagger2.9.2接口文档显示 swagger版本:2.9.2 框架:springboot2.1.2 当没有使用 @ApiImplicitParam和response=Resp.class时,swagger会自动去显示接口入参对象的各属性,及响应的对象属性,如下图: 而如果加入@ApiImplicitParam和response=Resp.class时,则没有任务字段属性显示,如下: 所以建议,当接口的入参为几个字段属性时可以加上@ApiImplicitParam进行描述,如果是对象,则只

  • swagger2隐藏在API文档显示某些参数的操作

    swagger2隐藏在API文档显示某些参数的操作

    swagger2隐藏在API文档显示某些参数 有时候,利用swagger2建立API文档时,有些参数是需要隐藏在API文档显示,在方法中,参数的名字前加上 @ApiIgnore 就可以了: @PostMapping("modi/certificate") @ApiResponses({@ApiResponse(code = 0, message = "请求成功"), @ApiResponse(code = 10031, message = "商家的营业执照

  • 永中文档在线转换预览基于nginx配置部署方案

    永中文档在线转换预览基于nginx配置部署方案

    目录 永中文档在线转换预览双活实现方案 永中文档在线转换预览双活实现方案 永中文档在线转换预览服务 是永中软件股份有限公司基于十多年核心技术积累.面向移动互联领域推出的 一款文档处理软件.永中采用自主可控核心技术,具备快速技术和服务响应能力,把文档原样输出为 HTML,图片等,即点即得.无需下载.保护文档隐私,快速高效,轻松实现文档在线安全阅读.​ 实现目标 通过nginx实现业务fcsserver负载均衡,后端可以动态扩展应用服务器nginx通过keepalived实现高可用,解决单点故障通过

  • golang组件swagger生成接口文档实践示例

    golang组件swagger生成接口文档实践示例

    目录 swagger介绍 gin-swagger实战 第一步:添加注释 第二步:生成接口文档数据 第三步:引入gin-swagger渲染文档数据 swagger介绍 Swagger本质上是一种用于描述使用JSON表示的RESTful API的接口描述语言.Swagger与一组开源软件工具一起使用,以设计.构建.记录和使用RESTful Web服务.Swagger包括自动文档,代码生成和测试用例生成. 在前后端分离的项目开发过程中,如果后端同学能够提供一份清晰明了的接口文档,那么就能极大地提高大家

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

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

    目录 永中文档转换服务简介 Swagger简介 添加依赖 配置Swagger 访问Swagger页面 调用get接口测试Swagger页面 调用post接口实现PDF文档转换预览 调用post接口实现OFFICE文档加水印 结语 永中文档转换服务简介 永中文档在线预览软件(即永中DCS)是永中Office针对政企单位提供的文件预览与文件转换服务,可同时供多个业务系统进行对接和集成,赋能业务系统实现Office文档.PDF.OFD等格式文档的在线预览与文档批量格式转换,支持80多种不同文件格式的文

  • 基于Python使用永中文档转换服务的方式

    基于Python使用永中文档转换服务的方式

    目录 1 上传文件再转换 2 复合型接口 3 针对在线文档的转换接口 4 小结 因为工作需要,最近开始学习Python:而项目上用到了永中文档转换服务,就想着要不要拿这个练练手.仰仗于Python的易用性,不一会就完成了.现在总结一下,作为二者的简单学习笔记. 1 上传文件再转换 查看了对应的接口文档后,先来上传一个文件试试: def upload():    url = 'http://172.18.21.87:48080/fcscloud/file/upload'    header = {

  • asp.net实现word文档在线预览功能的方法

    asp.net实现word文档在线预览功能的方法

    本文实例讲述了asp.net实现word文档在线预览功能的方法.分享给大家供大家参考.具体实现方法如下: 实现方式:office文档转html,再在浏览器里面在线浏览 1.首先引入com组件中office库,然后在程序集扩展中引入word的dll 2.将Microsoft.Office.Interop.Word的嵌入互操作类型设置为 false,如图 3.主要代码: 复制代码 代码如下: using System; using System.Collections.Generic; using

  • 使用FlashPaper在线转换.doc为.swf

    使用FlashPaper在线转换.doc为.swf

    FlashPaper 是Macromedia推出的一款电子文档类工具!通过使用FlashPaper,可以将需要的文档通过简单的设置转换为SWF格式的Flash动画,原文档的排版样式和字体显示不会收到影响,这样做的好处是不论对方的平台和语言版本是什么,都可以自由的观看你所制作的电子文档动画,并可以进行自由的放大,缩小和打印,翻页等操作! 展示的效果就像百度的文库查看效果. Flashpaper的使用相信大多数人都知道,这里的Demo是用于在线转换 .doc文件转换为 .swf的flash文件. 其

  • Java实现 word、excel文档在线预览

    Java实现 word、excel文档在线预览

    java实现办公文件在线预览功能是一个大家在工作中也许会遇到的需求,网上些公司专门提供这样的服务,不过需要收费 如果想要免费的,可以用openoffice,实现原理就是: 通过第三方工具openoffice,将word.excel.ppt.txt等文件转换为pdf文件流: 当然如果装了Adobe Reader XI,那把pdf直接拖到浏览器页面就可以直接打开预览,前提就是浏览器支持pdf文件浏览. 我这里介绍通过poi实现word.excel.ppt转pdf流,这样就可以在浏览器上实现预览了.

  • Java实现办公文档在线预览功能

    Java实现办公文档在线预览功能

    java实现办公文件在线预览功能是一个大家在工作中也许会遇到的需求,网上些公司专门提供这样的服务,不过需要收费 如果想要免费的,可以用openoffice,实现原理就是: 通过第三方工具openoffice,将word.excel.ppt.txt等文件转换为pdf文件流: 当然如果装了Adobe Reader XI,那把pdf直接拖到浏览器页面就可以直接打开预览,前提就是浏览器支持pdf文件浏览. 我这里介绍通过poi实现word.excel.ppt转pdf流,这样就可以在浏览器上实现预览了.

  • 微服务间调用Retrofit在Spring Cloud Alibaba中的使用

    微服务间调用Retrofit在Spring Cloud Alibaba中的使用

    目录 前置知识 搭建 使用 集成与配置 服务间调用 服务限流 熔断降级 总结 前置知识 在微服务项目中,如果我们想实现服务间调用,一般会选择Feign.之前介绍过一款HTTP客户端工具Retrofit,配合SpringBoot非常好用!其实Retrofit不仅支持普通的HTTP调用,还能支持微服务间的调用,负载均衡和熔断限流都能实现.今天我们来介绍下Retrofit在Spring Cloud Alibaba下的使用,希望对大家有所帮助! SpringBoot实战电商项目mall(50k+star

  • Asp.Net Core使用SignalR进行服务间调用方法示例

    网上查询过很多关于ASP.NET core使用SignalR的简单例子,但是大部分都是简易聊天功能,今天心血来潮就搞了个使用SignalR进行服务间调用的简单DEMO. 至于SignalR是什么我就不多说了,微软官方文档也不少. 第一步新建项目 所有VS开发第一步都是新建一个解决方案哈,这里我就不多介绍如何新建项目啦~~ 开发环境,VS2017,.NET CORE 2.1 新建两个asp.net core项目 如此简单的操作大家都懂的 注入SignalR 在被调用的服务端的Startup.cs中

  • 使用Python进行中文繁简转换的实现代码

    中文繁体.简体的差异,在NPL中类似英文中的大小写,但又比大小写更为复杂,比如同样为繁体字,大陆.香港和台湾又不一样.先前写过一篇中文繁简转换的文章,感觉写的不太详细,今天就针对Python下如何使用做进一步的记录. OpenCC(Open Chinese Convert) OpenCC是一个开源的中文繁简转化项目,支持词汇级别的转换.异体字转换和地区习惯用词转换(中国大陆.台湾.香港).主要特点为: 严格区分「一简对多繁」和「一简对多异」. 完全兼容异体字,可以实现动态替换. 严格审校一简对多

随机推荐