https://github.com/scottlogic/openapi-forge-java
https://github.com/scottlogic/openapi-forge-java
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/scottlogic/openapi-forge-java
- Owner: ScottLogic
- Created: 2023-01-09T11:59:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-25T08:25:27.000Z (over 2 years ago)
- Last Synced: 2025-01-31T19:39:52.645Z (11 months ago)
- Language: Java
- Size: 385 KB
- Stars: 1
- Watchers: 14
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## OpenAPI Forge - Java
This repository is the Java generator for the [OpenAPI Forge](https://github.com/ScottLogic/openapi-forge), see that repository for usage instructions.
## Configuration
OpenAPI Forge is opinionated in its approach, we don't provide a vast range of configuration options, just the essentials! You can list the generator-specific configuration options by running the `generate-options` command as follows:
```
% openapi-forge generator-options openapi-forge-java
This generator has a number of additional options which can be supplied when executing the 'forge' command.
Options:
--generator.package The package for the generated classes.
```
## Development
### Running
To run this generator, you also need to have [OpenAPI Forge](https://github.com/ScottLogic/openapi-forge) installed, or the repository checked out. Assuming you have it installed as a global module, you can run this generator as follows:
```
$ openapi-forge forge
\ https://petstore3.swagger.io/api/v3/openapi.json
\ .
\ -o api
```
This generates an API from the Pet Store swagger definition, using the generator within the current folder (`.`), outputting the results to the `api` folder.
Afterwards, by modiyfing the `Application.java` in the generated `api` project, we can fetch every `available` pet and print them into stdout.
```java
import java.util.List;
import java.util.stream.Collectors;
import okhttp3.OkHttpClient;
// ..
public CommandLineRunner commandLineRunner(ApplicationContext ctx) {
return args -> {
Configuration configuration = new Configuration();
configuration.basePath = "https://petstore3.swagger.io";
OkHttpClient client = new OkHttpClient();
ApiClientPet apiClientPet = new ApiClientPet(client, configuration);
HttpResponse> pets = apiClientPet.findPetsByStatus("available");
System.out.println(pets.data.stream().map(x -> x.getName()).collect(Collectors.toList()));
};
}
// ..
```
### Testing
The standard test script is used to execute the BDD-style tests against this generator.
```
npm run test
```
The script expects that the openapi-forge project (which is where the BDD feature files are located) is checked out at the same folder-level as this project. In-depth documentation can be found at [features/README.md](features/README.md).
### Linting
Two scripts are available to help you find linting errors:
```
npm run lint:check:all
```
This runs eslint in check mode which will raise errors found but not try and fix them. This is also ran on a PR and a push to main. It will fail if any errors were found.
```
npm run lint:write:all
```
This runs eslint in write mode which will raise errors found and try to fix them.