我有一个用Swagger编写的API,我想为它生成服务实现和客户端,它们必须在单独的maven模块中。
我想把它们分成3个独立的Maven模块(或同一父pom的子模块(。
parent
+- api
+- src/main/resources/api/service.yaml
+- client
+- service
然后,在客户端和服务中,我都会有swagger-codegen-maven-plugin
。这样,两者将同步,我将只在一个地方维护服务。其他客户端也可以依赖于api
工件,并从service.yaml
Swagger API定义生成它们的代码。
我的困难在于如何使服务和客户端引用另一个Maven依赖项中的service.yaml
?
这是我目前在服务pom.xml
中拥有的,但它指的是服务模块的本地资源,而不是api
maven依赖关系。
<plugin>
<groupId>io.swagger</groupId>
<artifactId>swagger-codegen-maven-plugin</artifactId>
<version>${io.swagger.codegen.version}</version>
<executions>
<execution>
<id>api</id>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<!-- can this refer to another maven dependency's resources? -->
<inputSpec>${basedir}/src/main/resources/api/service.yaml</inputSpec>
<language>spring</language>
<library>spring-boot</library>
<modelPackage>com.test.model</modelPackage>
<apiPackage>com.test.api</apiPackage>
<generateSupportingFiles>false</generateSupportingFiles>
<configOptions>
<java8>true</java8>
<dateLibrary>java8</dateLibrary>
<interfaceOnly>true</interfaceOnly>
</configOptions>
</configuration>
</execution>
</executions>
</plugin>
不确定这是我必须从Maven做的事情,引用另一个Maven依赖项中的资源,还是我必须在swagger插件配置中做的事情。
我设法找到的解决方案是使用maven-remote-resources-plugin
。在需要公开资源的maven项目的pom.xml
中,您可以放置:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-remote-resources-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>bundle</goal>
</goals>
</execution>
</executions>
<configuration>
<includes>
<include>**/*.yaml</include>
</includes>
</configuration>
</plugin>
</plugins>
</build>
然后在需要导入它们的项目中,该项目需要参考如下:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-remote-resources-plugin</artifactId>
<configuration>
<resourceBundles>
<resourceBundle>group:api:version</resourceBundle>
</resourceBundles>
</configuration>
<executions>
<execution>
<phase>
generate-sources
</phase>
<goals>
<goal>process</goal>
</goals>
</execution>
</executions>
</plugin>
其中group:api:version
是暴露资源的maven依赖关系的组ID、工件ID和版本。
最后,在swagger-codegen-maven-plugin
配置中,yaml文件可以称为:
<inputSpec>${project.build.directory}/maven-shared-archive-resources/api/service.yaml</inputSpec>