https://github.com/apiaddicts/openapi-example-aggregator

Project open source financed by Madrid Digital (Spain) and CloudAPPi S.L and promoted by APIAddicts. This proyect Generate examples for openapi3.0 using the responses schemas.
https://github.com/apiaddicts/openapi-example-aggregator

javascript openapi openapi3

Last synced: 7 months ago
JSON representation

Project open source financed by Madrid Digital (Spain) and CloudAPPi S.L and promoted by APIAddicts. This proyect Generate examples for openapi3.0 using the responses schemas.

• Host: GitHub
• URL: https://github.com/apiaddicts/openapi-example-aggregator
• Owner: apiaddicts
• License: other
• Created: 2025-02-03T13:47:13.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2025-03-28T20:36:59.000Z (7 months ago)
• Last Synced: 2025-03-28T21:29:49.960Z (7 months ago)
• Topics: javascript, openapi, openapi3
• Language: JavaScript
• Homepage:
• Size: 101 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🛠️ openapi-example-aggregator ![Release](https://img.shields.io/badge/release-1.1.0-purple) [![NPM](https://img.shields.io/badge/npm-%23CB3837.svg?style=flat&logo=npm&logoColor=white)](https://www.npmjs.com/package/openapi-example-aggregator) ![OpenApi](https://img.shields.io/badge/-openapi-%23Clojure?style=flat&logo=openapiinitiative&logoColor=white) [![License: LGPL v3](https://img.shields.io/badge/license-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)

**openapi-example-aggregator** creates automatic examples from Openapi 3.0.

### This repository is intended for :octocat: **community** use, it can be modified and adapted without commercial use. If you need a version, support or help for your **enterprise** or project, please contact us 📧 devrel@apiaddicts.org

[![Twitter](https://img.shields.io/badge/Twitter-%23000000.svg?style=for-the-badge&logo=x&logoColor=white)](https://twitter.com/APIAddicts)

[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/ZdbGqMBYy8)

[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/company/apiaddicts/)

[![Facebook](https://img.shields.io/badge/Facebook-%231877F2.svg?style=for-the-badge&logo=Facebook&logoColor=white)](https://www.facebook.com/apiaddicts)

[![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge&logo=YouTube&logoColor=white)](https://www.youtube.com/@APIAddictslmaoo)

# 🙌 Join the **openapi-example-aggregator** Adopters list

📢 If openapi-example-aggregator is part of your organization's toolkit, we kindly encourage you to include your company's name in our Adopters list. 🙏 This not only significantly boosts the project's visibility and reputation but also represents a small yet impactful way to give back to the project.

| Organization                         | Description of Use / Referenc               |

| ------------------------------------ | ------------------------------------------- |

| [CloudAppi](https://cloudappi.net/)  | Apification and generation of microservices |

| [APIquality](https://apiquality.io/) | Common contributor                          |

# 👩🏽‍💻 Contribute to ApiAddicts

We're an inclusive and open community, welcoming you to join our effort to enhance ApiAddicts, and we're excited to prioritize tasks based on community input, inviting you to review and collaborate through our GitHub issue tracker.

Feel free to drop by and greet us on our GitHub discussion or Discord chat. You can also show your support by giving us some GitHub stars ⭐️, or by following us on Twitter, LinkedIn, and subscribing to our YouTube channel! 🚀

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/apiaddicts)

# 📑 Getting started

[![NPM](https://img.shields.io/badge/openapi--example--aggregator-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white)](https://www.npmjs.com/package/openapi-example-aggregator)

### Install package

```

npm i openapi-example-aggregator -g

```

### First steps

#### `Arguments`

| argv        | a   | description                 |

| ----------- | --- | --------------------------- |

| --file      | -f  | path openapi file           |

| --overwrite | -o  | overwrite the original file |

#### `Normal` usage

```

oea  -f .\example\petstore.yaml

```

## Table of content

- [Structure and submodules](#structure-and-submodules)

- [Build and run](#build-and-run)

  - [Prerequisites](#prerequisites)

  - [Get the latest changes](#get-the-latest-changes)

- [Contribute](#contribute)

  - [IDE support](#ide-support)

    - [IntelliJ IDEA](#intellij-idea)

    - [Eclipse](#eclipse)

## Structure and submodules

- _[example](example)_ - Integration and system tests for SoapUI.

- _[src](src)_ – Source code

- _[test](soapui-maven-plugin-tester)_ - Testing folder

## Build and run

### Prerequisites

You need node v14 or later.

### Workspace configuration

Node.js and npm package manager are required to run the tool. Its adviced to use preconfigured installation tools provided by the manufacturer:

[https://nodejs.org/es/download/](https://nodejs.org/es/download/)

## 💛 Sponsors