`
vipbooks
  • 浏览: 148948 次
  • 性别: Icon_minigender_1
  • 来自: 长沙
社区版块
存档分类

基于Swagger自动生成离线API文档(Word、Markdown文档)

SwaggerOpenAPIJavaAPIMarkdown 
阅读更多
    在做项目时通常需要给客户提供离线Word的API文档归档，不要跟客户说有Swagger在线API文档，客户不会用也不会去看。只要你有Swagger，TableGo就能自动生成一份漂亮的Word离线API文档给客户，大大提高了写文档的效率，客户看了高兴，大家项目交付的速度也快很多。支持Swagger2和Swagger3 OpenAPI3，使用TableGo的自定义模板功能还能生成Markdown格式的离线API文档。

1、首先打开Swagger找到api-docs的访问地址，这个地址提供了Swagger的文档JSON数据，离线文档就是利用这些JSON数据来生成的




2、打开TableGo，找到并打开生成工具 → 生成自定义文件 → Swagger




3、将api-docs的访问地址填入“在线访问地址”，也可以把api-docs的JSON数据保存到本地JSON文件中，选择离线JSON数据文件




   配置文档标题，文档标题用于生成文件名和文档标题，title对应“info.title”，description对应“info.description”


   如果只想生成指定模块的API数据，可以在模板设置中选择需要的模块


   点击“生成Word离线API文档”按钮即可生成文档


4、打开Document目录，查看刚生成的离线API文档










5、使用TableGo的自定义模板功能还能生成Markdown格式的离线API文档


http://www.tablego.cn
https://gitee.com/vipbooks/TableGo
https://github.com/vipbooks/TableGo
0
顶
0
踩
分享到：
自动生成数据库设计文档，支持多数据源批量 ...
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    swagger生成html离线接口文档

    Swagger UI是一个基于Web的工具，它可以解析Swagger Spec文件并生成用户友好的接口文档，用户可以通过它来浏览、测试和理解API。 Spring Boot与Swagger 2的集成使得在Java环境中使用Swagger变得更加简单。`...

    asp.net webapi集成swagger自动生成接口文档(亲测可用)

    asp.net webapi集成swagger自动生成接口文档(亲测可用)swagger生成html离线接口文档swagger生成html离线接口文档

    基于SpringBoot和Swagger2生成离线文档：PDF和Html5格式.zip

    标题中的“基于SpringBoot和Swagger2生成离线文档：PDF和Html5格式”是指使用SpringBoot框架和Swagger2工具来创建API文档，并将其导出为可供离线阅读的PDF和HTML5格式。这一过程涉及了几个关键的IT知识点： 1. **...

    swagger文档离线导出,word、pdf、html

    Swagger 文档离线导出功能则是为了在没有网络连接的情况下，依然能访问和使用 API 的详细信息。 Swagger 文档可以导出为多种格式，包括 Word（.docx）、PDF、HTML、SVG 和 XML。这些格式各有其用途： 1. **Word ...

    swagger2离线文档生成项目

    用swagger2markup导出swagger2项目的html，pdf的离线文档。解决生成pdf中文乱码以及缺失的问题，支持自定义字体。 修改pom.xml中的 swagger.input属性值中的ip和port 执行mvn clean test完成之后，会在/target/...

    swagger官方文档离线版

    8. **文档化**：Swagger UI，一个基于Swagger 2.0规范的可视化界面，可以从文档生成交互式的API探索界面，帮助开发者直观地测试和理解API。 9. **代码生成**：Swagger 2.0文档可以被各种工具（如Swagger Codegen）...

    swagger在线文档转成word文档

    本篇文章将详细讲解如何在SpringBoot项目中利用Swagger生成的在线文档转换成Word文档。 首先，我们需要在SpringBoot项目中集成Swagger2。Swagger2提供了一个简洁的方式来定义和文档化RESTful APIs。通过添加`...

    markdown-swagger：将Swagger文件中的API文档生成为markdown文件

    将Swagger文件中的API文档生成为markdown文件。 安装 npm install markdown-swagger 用法 markdown-swagger ./api/swagger/swagger.yaml ./README.md 这将读取指定的swagger文件并生成一个表，该表描述目标markdown...

    使用springfox-staticdocs生成swagger离线api项目源码

    Springfox 是一个流行的 Java 库，用于为基于 Spring 的应用程序自动生成 Swagger API 文档。Swagger 是一种用于设计、构建、文档化和使用 RESTful web 服务的工具。它通过注解来描述 API，使得开发者可以方便地生成...

    Swagger3生成API文档配置（Demo）

    本教程将指导你如何配置 Swagger3 以生成 API 文档，并以一个实际的Demo为例进行演示。 首先，我们需要在Spring Boot项目中引入Swagger3的相关依赖。在`pom.xml`文件中，添加以下依赖： ```xml <groupId>io....

    SwaggerOfflineDoc：基于SpringBoot和Swagger2生成离线文档：PDF和HTML5格式

    SwaggerOfflineDoc基于SpringBoot和Swagger2生成离线文档：PDF和HTML5格式具体参考： ://blog.csdn.net/fly910905/article/details/79131755

    基于SwaggerSwaggeropenapi30规范通过配置SwaggerJSON生成API文档

    在这个项目中，开发者可能已经按照OpenAPI 3.0规范编写了Swagger JSON配置，并结合Swagger UI或类似工具，生成了详细的API文档。同时，这个库可能还包含了与API相关的JavaScript代码示例或者完整的API实现。 总的来...

    Web API安装swagger控件，自动生成api接口文档

    本教程将详细讲解如何在Web API项目中安装Swagger控件，并利用它自动生成API接口文档。 首先，让我们了解一下Swagger。Swagger是一个开源项目，用于设计、构建、文档化和使用RESTful Web服务。它提供了规范化的描述...

    swagger导出静态API文档工具

    Swagger导出静态API文档工具是基于Swagger的一个实用工具，它是一个Maven工程，这意味着我们可以利用Maven的构建生命周期来自动化文档的生成过程。 首先，让我们了解Maven。Maven是一个项目管理工具，它通过读取...

    将Swagger2文档导出为HTML或markdown等格式离线阅读解析

    Swagger2文档导出为HTML或markdown格式离线阅读解析 Swagger2文档导出为HTML或markdown格式离线阅读是指将Swagger2文档导出为离线阅读的格式，以便在没有网络连接的情况下访问接口文档。本文将详细介绍将Swagger2...

    SpringBoot结合Swagger自动生成api文档.docx

    ### Spring Boot 结合 Swagger 自动生成 API 文档详解 #### 一、使用 IntelliJ IDEA 搭建 Spring Boot 工程 在正式介绍如何利用 Spring Boot 和 Swagger 来自动生成 API 文档之前，首先需要了解如何使用 IntelliJ ...

    基于Swagger与Zuul的API文档管家设计源码

    API文档管家 - 基于Swagger与Zuul的API文档管家设计源码 - 包含21个文件，如.java、.xml、.properties、.png等。该系统通过Swagger和Zuul实现，为用户提供了一个强大的API文档管理工具，帮助开发者更好地管理和维护...

Magicbox
Global site tag (gtag.js) - Google Analytics