-
Notifications
You must be signed in to change notification settings - Fork 125
Endpoints
Matt Dean edited this page Jan 3, 2018
·
4 revisions
This is for version 0.9.0 and below. The documentation for v1.0.0+ can be found here
The :endpoints subproject is responsible for generating files based on URIs found in endpoints.json and methods annotated with the @EndpointImplementation annotation.
AbstractEndpointGenerator provides a template for a class that generates or modifies a file based off of the information that EndpointAnalyzer provides.
EndpointAnalyzer hosts the subproject's main method, which takes three arguments. Each of these arguments corresponds to a separate AbstractEndpointGenerator. To invoke this class using Gradle, run gradle endpoints:update.
| Name | Purpose |
|---|---|
JavaGenerator |
Generates Endpoints.java
|
MarkdownGenerator |
Generates ENDPOINTS.md. |
ReadmeGenerator |
Updates the "api-coverage" badge in README.md
|