Swagger使用笔记

最新推荐文章于 2025-06-02 09:03:29 发布

DevilCo_o

最新推荐文章于 2025-06-02 09:03:29 发布

阅读量545

点赞数 1

CC 4.0 BY-SA版权

分类专栏： Spring 文章标签： spring java swagger2 微服务

本文链接：https://blog.youkuaiyun.com/weixin_42440637/article/details/111569796

这篇笔记介绍了如何使用Swagger Codegen从OpenAPI规范的文件生成服务端代码。详细讲述了添加依赖、调用方式，特别是通过maven插件进行编译的步骤，并分享了在生成过程中遇到的问题及解决方案。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Swagger使用笔记

使用Swagger Codegen生成代码

参考github:https://github.com/swagger-api/swagger-codegen
先在项目pom中增加依赖：

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    <version>2.4.17</version>
</dependency>

增加依赖后就可以看到插件的源码了，后面碰到问题翻一下代码也方便

插件介绍

Gittee仓库：https://gitee.com/mirrors/swagger-codegen?_from=gitee_search
官方介绍：
在这里插入图片描述
总结：关键词OpenAPI、服务端、客户端、文档。swagger-codegen可以根据符合OpenAPI定义规范的文件，生成对应的服务端、客户端代码，接口的说明文档。

调用方式

目前我了解的调用方式主要有以下两种：

通过官方提供的jar包直接调用 java swagger-codegen-cli.jar xx xx
通过集成maven插件，在pom中执行编译步骤调用，本篇文章也主要用这种方式。

生成服务端代码

定义接口描述文件yaml
以一个最简单的get接口为例，yaml内容如下：

swagger: "2.0"
info:
  description: "测试swagger"
  version: "1.0.0"
  title: "测试api"

paths:
  /test:
    get:
      consumes:
        - application/json
      produces:
        - application/json
      response:
        200:
          description: 成功

目录结构：
3. 配置maven编译步骤，调用swagger-codegen-maven-plugin

<plugin>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    <version>2.3.1</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
            <configuration>