https://github.com/rspereiratech/openapi-collection-generator-parent
Maven plugin that generates Postman and Insomnia collections from OpenAPI 3.x specs, integrated into the Maven build lifecycle.
https://github.com/rspereiratech/openapi-collection-generator-parent
api-tools code-generation insomnia java maven-plugin openapi openapi3 postman
Last synced: about 1 month ago
JSON representation
Maven plugin that generates Postman and Insomnia collections from OpenAPI 3.x specs, integrated into the Maven build lifecycle.
- Host: GitHub
- URL: https://github.com/rspereiratech/openapi-collection-generator-parent
- Owner: rspereiratech
- License: mit
- Created: 2026-05-08T14:13:25.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2026-05-08T17:21:56.000Z (2 months ago)
- Last Synced: 2026-05-08T19:22:47.399Z (2 months ago)
- Topics: api-tools, code-generation, insomnia, java, maven-plugin, openapi, openapi3, postman
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# OpenAPI Collection Generator
[](https://github.com/rspereiratech/openapi-collection-generator-parent/actions/workflows/build.yml)
[](LICENSE)
[](https://nowpayments.io/donation/rspereiratech)
A Maven plugin that generates API client collections from OpenAPI specifications.
## Problem
Working with REST APIs often requires importing endpoints into tools like **Postman** or **Insomnia** for testing and development. Manually creating and maintaining these collections is tedious, error-prone, and quickly becomes outdated as APIs evolve.
## Solution
**OpenAPI Collection Generator** reads your OpenAPI (3.x) specification and automatically generates ready-to-import collection files for Postman and Insomnia. It integrates directly into the Maven build lifecycle, ensuring your collections are always in sync with your API definition.
### Features
- Generates **Postman v2.1** collections
- Generates **Insomnia v4** exports
- Supports generating **multiple formats** in a single execution
- Configurable **output directory** and **file naming pattern**
- Automatic **environment file** generation (e.g. server URLs)
- Runs during the `generate-resources` phase by default
## Module Structure
| Module | Description |
|---|---|
| `openapi-collection-generator-parent` | Parent POM with shared dependency management |
| `openapi-collection-generator-core` | Core library with generation orchestration, parsing, and writing |
| `openapi-collection-generator-postman` | Postman collection generator |
| `openapi-collection-generator-insomnia` | Insomnia collection generator |
| `openapi-collection-generator-maven-plugin` | Maven plugin (thin wrapper over core) |
## Usage
### 1. Add the plugin to your `pom.xml`
```xml
io.github.rspereiratech
openapi-collection-generator-maven-plugin
1.0.0-SNAPSHOT
generate
POSTMAN
INSOMNIA
My_API
```
### 2. Place your OpenAPI spec
By default, the plugin looks for the spec at:
```
src/main/resources/openapi.yaml
```
### 3. Run the build
```bash
mvn generate-resources
```
This produces:
```
target/generated-collections/
My_API_postman.json
My_API_insomnia.json
My_API.Production.environment.json
```
## Configuration Reference
| Parameter | Property | Default | Description |
|---|---|---|---|
| `specFile` | `openapi.spec` | `${project.basedir}/src/main/resources/openapi.yaml` | Path to the OpenAPI specification file |
| `outputDirectory` | `openapi.outputDir` | `${project.build.directory}/generated-collections` | Output directory for generated files |
| `formats` | `openapi.formats` | `POSTMAN` | List of formats to generate (`POSTMAN`, `INSOMNIA`) |
| `collectionName` | `openapi.collectionName` | API title from spec | Name used in the output file name |
| `baseUrl` | `openapi.baseUrl` | URL from spec | Base URL override for the collection |
| `fileNamePattern` | `openapi.fileNamePattern` | `{name}_{format}.json` | Output file name pattern. Supports `{name}` and `{format}` placeholders |
### File Name Pattern
The `fileNamePattern` parameter controls the output file name. Available placeholders:
- `{name}` - replaced with the collection name (sanitized)
- `{format}` - replaced with the format in lowercase (`postman`, `insomnia`)
Examples:
```xml
{name}_{format}.json
{format}_{name}.json
```
> **Note:** When generating multiple formats, the pattern **must** contain `{format}` to avoid file name collisions. The plugin will fail with a clear error message if this rule is violated.
### Single Format
To generate only one format, specify a single entry:
```xml
POSTMAN
```
When using a single format, the `{format}` placeholder is optional in the file name pattern.
## Requirements
- Java 17+
- Maven 3.9+
## Contributing
Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on reporting issues, setting up the development environment, and submitting pull requests.
## Security
If you discover a security vulnerability, please follow the process described in [SECURITY.md](SECURITY.md). Do not open a public issue for security reports.
## Support
[](https://nowpayments.io/donation/rspereiratech)
If this project saves you time, consider supporting development
via [NOWPayments](https://nowpayments.io/donation/rspereiratech).
Every contribution helps keep it maintained — thank you!
## License
[MIT](LICENSE) © 2026 rspereiratech