swagger文档转html

swagger文档在开发时是一个很大的助力,但是在对外提供接口文档时就不是很灵活。

这里记录一下从swagger文档转html的方法(还能转pdf,暂时用不上)。

先建立一个空的maven项目,在pom中添加

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <file_encoding>UTF-8</file_encoding>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>io.github.swagger2markup</groupId>
                <artifactId>swagger2markup-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <!--此处填要生成文档的swagger2 json api地址-->
                    <swaggerInput>http://localhost:8081/v2/api-docs?group=0.1%E7%89%88</swaggerInput
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger是一种用于创建、设计、构建和编写API文档的工具,它提供了多种功能,包括自动生成文档的能力。然而,Swagger默认只提供了HTMLJSON格式的文档输出,没有直接支持将Swagger文档换为Word格式的选项。 要将Swagger在线换为Word文档,可以使用以下步骤: 第一步是下载Swagger文档Swagger文档通常以JSON格式或YAML格式提供。通过访问Swagger UI界面,我们可以获取到Swagger文档的URL或下载链接。 第二步是将Swagger文档换为OpenAPI规范(也称为Swagger规范)。可以使用Swagger Editor或Swagger CLI工具加载Swagger文档,并将其另存为OpenAPI YAML文件。这个规范文件将作为后续步骤的输入。 第三步是使用一些在线或本地的工具来将OpenAPI规范换为Word文档。这些工具通常支持将YAML文件换为Word文档,并按照预定的格式和样式来呈现API文档内容。 一些在线工具或服务提供了Swagger到Word文档换功能。你可以通过搜索引擎查找这些工具,如"Swagger to Word converter online"或"OpenAPI to Word converter"。选择合适的工具,并根据其提供的说明上传OpenAPI规范文件,然后选择换为Word文档的选项。 最后,下载并保存换完成的Word文档。根据换工具的要求,可能需要进行一些格式或样式的调整,以使文档符合个人或组织的需求。 需要注意的是,换工具的质量和功能各有不同。建议在选择换工具时,查看其用户评价和使用示例,以确保它能够满足你的具体需求。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值