swagger-maven-plugin自动生成swagge.json（Jersey项目）

最新推荐文章于 2025-04-08 10:35:36 发布

轻舞飞扬2014

最新推荐文章于 2025-04-08 10:35:36 发布

阅读量2.1k

点赞数

本文链接：https://blog.youkuaiyun.com/u013796473/article/details/77678056

版权

本文介绍了如何在Jersey项目中，通过swagger-maven-plugin插件来自动化生成swagger.json文件。首先，引入swagger-jersey2-jaxrs依赖，接着配置swagger-maven-plugin插件，包括指定API源、基本信息、输出目录等。然后，在控制器上添加必要的Swagger注解以定义API。最后，执行mvn compile生成swagger.json。

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

1，加入依赖

<dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-jersey2-jaxrs</artifactId>
            <version>1.5.0</version>
        </dependency>

2，加入插件

<plugin>
                <groupId>com.github.kongchen</groupId>
                <artifactId>swagger-maven-plugin</artifactId>
                <version>3.1.1</version>
                <configuration>
                    <apiSources>
                        <apiSource>
                            <springmvc>false</springmvc>
                            <locations>com.gionee.geip.web</locations>
                            <schemes>http,https</schemes>
                            <host>xxxx</host>
                            <basePath>/api</basePath>
                            <info>
                                <title>Swagger Maven Plugin Sample</title>
                                <version>v1</version>
                                <description>
                                    This is a sample.
                                </description>
                                <termsOfService>
                                    http://www.github.com/kongchen/swagger-maven-plugin
                                </termsOfService>
                                <contact>
                                    <email>xxx</email>
                                    <name>xxx</name>
                                    <url>xxx</url>
                                </contact>
                                <license>
                                    <url>http://www.apache.org/licenses/LICENSE-2.0.html</url>
                                    <name>Apache 2.0</name>
                                </license>
                            </info>
                            <securityDefinitions>
                            </securityDefinitions>
                            <swaggerDirectory>${basedir}/src/main/generated</swaggerDirectory>
                        </apiSource>
                    </apiSources>
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>io.swagger</groupId>
                        <artifactId>swagger-hibernate-validations</artifactId>
                        <version>1.5.6</version>
                    </dependency>
                </dependencies>
            </plugin>

3,加入注释

@Controller
@Path("/geip")//必须
@Api(value = "/geip", description = "Operations about WebController")//必须
public class WebController {

    @Autowired
    private GeipManager geipManager;

    @GET
    @Path("/test")
    @ApiOperation(value = "test",
            notes = "test"
    )//必须
    public String test() {
        return "test";
    }

}

4，执行mvn compile