https://github.com/remarkablemark/setup-openapi
🟢 Set up GitHub Actions workflow with OpenAPI Generator.
https://github.com/remarkablemark/setup-openapi
composite-action github-action github-action-composite github-actions openapi openapi-codegen openapi-generator openapi-generator-cli
Last synced: about 2 months ago
JSON representation
🟢 Set up GitHub Actions workflow with OpenAPI Generator.
- Host: GitHub
- URL: https://github.com/remarkablemark/setup-openapi
- Owner: remarkablemark
- License: mit
- Created: 2025-03-02T20:29:32.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2026-04-24T01:43:24.000Z (about 2 months ago)
- Last Synced: 2026-04-24T03:31:22.168Z (about 2 months ago)
- Topics: composite-action, github-action, github-action-composite, github-actions, openapi, openapi-codegen, openapi-generator, openapi-generator-cli
- Language: Python
- Homepage: https://github.com/marketplace/actions/setup-openapi
- Size: 42 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# setup-openapi
[](https://github.com/remarkablemark/setup-openapi/releases)
[](https://github.com/remarkablemark/setup-openapi/actions/workflows/test.yml)
[](https://opensource.org/licenses/MIT)
🟢 Set up GitHub Actions workflow with [OpenAPI Generator CLI](https://openapi-generator.tech/docs/installation/).
This action installs Java, downloads the OpenAPI Generator CLI, caches it by version, and exposes the binary.
## Quick Start
```yaml
# .github/workflows/openapi.yml
on: push
jobs:
openapi:
runs-on: ubuntu-latest
steps:
- name: Setup OpenAPI
uses: remarkablemark/setup-openapi@v1
- name: Generate Ruby Client
run: openapi-generator-cli generate -i petstore.yaml -g ruby -o /tmp/test/
```
## Usage
Install OpenAPI Generator CLI tool:
```yaml
- uses: remarkablemark/setup-openapi@v1
```
Generate a Ruby client from an [OpenAPI spec](https://petstore3.swagger.io/):
```yaml
- run: openapi-generator-cli generate -i petstore.yaml -g ruby -o /tmp/test/
```
See [action.yml](action.yml)
## Inputs
### `version`
**Optional**: The OpenAPI Generator CLI version. Defaults to [7.22.0](https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.22.0/).
```yaml
- uses: remarkablemark/setup-openapi@v1
with:
version: 7.22.0
```
### `name`
**Optional**: The OpenAPI Generator CLI binary name. Defaults to `openapi-generator-cli`.
```yaml
- uses: remarkablemark/setup-openapi@v1
with:
name: openapi-generator-cli
```
## License
[MIT](LICENSE)