swagger2 导出离线 word文档

位置:首页>文章>详情   分类: 教程分享 > Java教程   阅读(1713)   2023-03-28 11:29:14


Swagger2 导出离线文档简述

继上一篇搬运国外的swagger2导出离线文档之后,最近发现国内一款不错的swagger ui组件和导出离线的方法,比之前的更简单优雅。这里主要用的组件是下面的:
<dependency>
  <groupId>net.ifok.swagger</groupId>
  <artifactId>swagger-spring-boot-starter</artifactId>
  <version>1.3.0</version>
</dependency>

Swagger2 如何导出离线word呢?

本次的方法非常简单,首先新建一个spring boot项目,建议。2.2.x-2.4.x版本,可以直接引入上方的组件即可。

项目的pom.xml依赖部分看起来像这样:
$title(pom.xml)
<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>net.ifok.swagger</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.3.0</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

其他低版本的spring boot 使用,请参考说明 Swagger Spring Boot Stater

接下来就是配置了,配置我这里建议使用yml格式的,因为yml格式支持UTF8编码,可以更好的使用中文。当然properties 通过编码转换也行。下面就是一个简单的yml格式配置例子
$title(application.yml)
spring:
  swagger:
    api-title: 某某APP接口文档
    api-version: v1.0
    contact:
      url: https://www.leftso.com
      email: example@leftso.com
      name: leftso.com
    url-pattern: /api/**

更多的配置请参考说明:Swagger Spring Boot Stater


编写一个测试用的controller
$title(DemoController.java)
package com.example.swagger;

import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @Description:  测试类
 * @Author: xq 
 * @Date: 2021/3/17 8:51
 **/
@RestController
@RequestMapping("/api/")
public class DemoController {

    @ApiOperation("get获取接口")
    @GetMapping("get")
    public String getData(String param){
        return "Ok";
    }

    @ApiOperation("post提交接口")
    @PostMapping("post")
    public Result postData(String name,String age){
        return Result.success(name);
    }
}

启动项目,并访问 http://localhost:8080/doc.html
操作示例图-1615948545425.png


离线导出word的重点来了,首先点开文档管理,就可以看到离线文档栏目
操作示例图-1615948609212.png

点击箭头指的地方,下载一个word文件,word文件的格式大概如下:
part1
part1
 
part2
part2
part3
part3
part4
part4
part5
part5


 
地址:https://www.leftso.com/article/794.html

相关阅读

Swagger2 导出离线文档简述继上一篇搬运国外的swagger2导出离线文档之后,最近发现国内一款不错的swagger ui组件和导出离线的方法,比之前的更简单优雅
1.前言通过前面的两篇博客Spring Boot Security Swagger2整合生成安全的在线REST API文档 SpringMVC也可参考spring boot REST 通过Swa...
【重要提示】:目前已有更好的方法,可以参考:Swagger2 导出离线 word文档一、使用背景    如今,REST和微服务已经有了很大的发展势头
java通过freemarker导出word循环合并表格单元格本文主要讲解通过freemarker模板引擎来导出word,并且在word中包含表格的合并部分需要循环生成
Java word模板导出easypoi篇项目源码下载:demo-easypoi-word-template.zip 访问密码9987一、maven依赖 &lt;!--easypo...
swagger dataType 有那些2.6.x"int", "date", "string", "double", "float", "boolean", "byte", "object",...
springfox swagger 请求参数类型设置解析类:springfox.documentation.spring.web.readers.parameter.ParameterTypeR...
eclipse复制高亮代码到word中
Swagger Spring Boot Stater简介spring boot 整合 springfox 实现swagger api文档生成
创建REST API时,良好的文档是有帮助的。而且,API中的每一个变化都应该在参考文档中同时描述。手动完成这是一个乏味的操作,因此这个过程的自动化是不可避免的。