swagger2的使用和swagger2markup离线文档的生成（最简单的方式）

最新推荐文章于 2024-08-28 17:14:55 发布

余生之君

最新推荐文章于 2024-08-28 17:14:55 发布

阅读量6.2k

点赞数 4

分类专栏： springboot 文章标签： swagger swagger接口404 swagger接口无法访问 swagger离线文档 Swagger2Markup离线文档

本文链接：https://blog.csdn.net/java_collect/article/details/84480588

版权

本文档介绍了如何使用Swagger2创建在线接口文档，解决swagger-ui访问404问题，并通过Swagger2Markup生成离线PDF/HTML格式的接口文档。详细步骤包括引入依赖、配置Swagger2、注解接口信息，以及解决访问接口时可能遇到的静态资源问题。同时提供了一个简化配置的demo工程，帮助快速生成离线文档。

摘要由CSDN通过智能技术生成

文章目录

Swagger会自动根据我们的接口来生成一个html页面，在这个页面上我们可以看到所有接口信息，信息中包含了有哪些参数，每个参数代表什么意思，如果是一个带body体的请求，还会自动帮我们生成json格式的body。并且还可以像http请求工具那样进行接口请求.极大的方便了我们编写接口文档。
作用：

接口的文档在线生成
接口功能测试，替代postman

1. 如何使用

1.1 引入依赖

注意版本，经常会有些意想不到的问题。2.2.2也是比较常用的版本

 <!--swagger的依赖start-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.4.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.4.0</version>
        </dependency>
 <!--swagger的依赖end-->

1.2 创建swagger2配置类

@Configuration
@EnableSwagger2
public class Swagger2Config {
   
//swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {
   
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.jun.cloud"))