https://github.com/spurreiter/openapi-builder

builder for openapi files
https://github.com/spurreiter/openapi-builder

Last synced: 3 months ago
JSON representation

builder for openapi files

• Host: GitHub
• URL: https://github.com/spurreiter/openapi-builder
• Owner: spurreiter
• License: mit
• Created: 2020-06-29T18:35:01.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-31T10:55:02.000Z (over 4 years ago)
• Last Synced: 2025-02-08T00:46:09.498Z (3 months ago)
• Language: JavaScript
• Size: 55.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# openapi-builder

> builder for openapi files

Editing large or very large yaml files is for the real masters of the api-verse.

If you prefer to have some smaller files in folders which shall construct the later,

this project might be for you.

It allows to create the component references in individual files, together with mixins.

## Installation

```

npm i -g openapi-builder

```

## Usage

create a new environment

```bash

mkdir examples mixins paths parameters responseBodies responses schemas securitySchemes

touch main.yaml

openapi-builder init

```

This creates a `.openapi-builder.json` configuration file in this folder.

Please take a look at the [example](./example) folder. Watch out for `$schemas$`, `$mixins` or `$mixin` tags.

Will try to complete the docs later...

build the final openapi yaml file with

```bash

openapi-builder

```

## License

Source code is [MIT](./LICENSE) licensed

The example uses the well known swagger [petstore](https://editor.swagger.io) which is licensed under Apache 2.0