Skip to content

cloudaware/endpoints-maven-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About

This plugin has 2 goals:

  • gen-docs will generate discovery documents and openapi.json from your API classes
  • gen-guice will generate EndpointsModule for guice using the same set of classes

Usage

    <build>
        <plugins>
            <plugin>
                <groupId>com.cloudaware</groupId>
                <artifactId>endpoints-maven-plugin</artifactId>
                <version>1.0.1</version>
                <configuration>
                    <urlPattern>/_ah/api/*</urlPattern>
                    <basePath>/_ah/api</basePath>
                    <apis>
                        <param>com.company.project.SomeApi</param>
                        <param>com.company.project.OtherApi</param>
                    </apis>
                </configuration>
                <executions>
                    <execution>
                        <id>gen-docs</id>
                        <goals>
                            <goal>package</goal>
                        </goals>
                        <configuration>
                            <hostname>yourapi.endpoints.yorproject.cloud.goog</hostname>
                            <warPath>${project.build.directory}/${project.build.finalName}</warPath>
                            <outputSwaggerDoc>${project.basedir}/swagger.json</outputSwaggerDoc>
                            <outputDiscoveryDocs>${project.basedir}/discovery</outputDiscoveryDocs>
                        </configuration>
                    </execution>
                    <execution>
                        <id>gen-guice</id>
                        <goals>
                            <goal>generate-sources</goal>
                        </goals>
                        <configuration>
                            <outputClassName>com.company.project.YourEndpointsModule</outputClassName>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

Changelog

  • 1.0.8 - Migrate to Jakarta EE, Cloudaware endpoints framework dependency, hostname parameter fix
  • 1.0.7 - Windows fix
  • 1.0.6 - Bump versions, skip overwrite generated file, if content equals
  • 1.0.5 - Added required parameter for basePath (to use in conjunction with urlPattern)
  • 1.0.2 - Change version
  • 1.0.1 - Less dependencies
  • 1.0.0 - Initial release

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages