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: 3 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 (3 months ago)
• Default Branch: master
• Last Pushed: 2025-03-02T21:18:17.000Z (3 months ago)
• Last Synced: 2025-03-02T21:29:01.232Z (3 months ago)
• Topics: composite-action, github-action, github-action-composite, github-actions, openapi, openapi-codegen, openapi-generator, openapi-generator-cli
• Homepage: https://github.com/marketplace/actions/setup-openapi
• Size: 0 Bytes
• Stars: 0
• 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

[![version](https://badgen.net/github/release/remarkablemark/setup-openapi)](https://github.com/remarkablemark/setup-openapi/releases)

[![test](https://github.com/remarkablemark/setup-openapi/actions/workflows/test.yml/badge.svg)](https://github.com/remarkablemark/setup-openapi/actions/workflows/test.yml)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

🟢 Set up GitHub Actions workflow with [OpenAPI Generator](https://openapi-generator.tech/docs/installation/).

## 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 a valid [petstore.yaml](https://petstore3.swagger.io/) doc:

```yaml

- run: openapi-generator-cli generate -i petstore.yaml -g ruby -o /tmp/test/

```

See [action.yml](action.yml)

> [!NOTE]

> On Windows, you'll need to install a higher Java version:

>

> ```yaml

> on: push

> jobs:

>   openapi:

>     runs-on: windows-latest

>     steps:

>       - uses: actions/setup-java@v4

>         with:

>           distribution: temurin

>           java-version: 21

>       - uses: remarkablemark/setup-openapi@v1

> ```

## Inputs

### `version`

**Optional**: The OpenAPI Generator version. Defaults to latest.

```yaml

- uses: remarkablemark/setup-openapi@v1

  with:

    version: 7.9.0

```

## License

[MIT](LICENSE)