https://github.com/paulvollmer/openapi-split

openapi-split is a simple commandline tool to organize an openapi (swagger) specification across multiple files
https://github.com/paulvollmer/openapi-split

openapi openapi-split swagger

Last synced: 23 days ago
JSON representation

openapi-split is a simple commandline tool to organize an openapi (swagger) specification across multiple files

• Host: GitHub
• URL: https://github.com/paulvollmer/openapi-split
• Owner: paulvollmer
• License: mit
• Created: 2017-08-12T09:11:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-05-20T22:17:55.000Z (over 5 years ago)
• Last Synced: 2024-10-03T18:46:23.988Z (about 1 month ago)
• Topics: openapi, openapi-split, swagger
• Language: Go
• Homepage:
• Size: 15.6 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# OpenAPI Split [![Build Status](https://travis-ci.org/paulvollmer/openapi-split.svg?branch=master)](https://travis-ci.org/paulvollmer/openapi-split)

`openapi-split` is a simple commandline tool to organize an openapi (swagger) specification across multiple files.

the tool read `yaml` files from different directories like `paths`, `definitions` and `responses` to build a single openapi spec file.

**THIS IS AN ALPHA RELEASE. KEEP IN MIND THERE CAN BE MAJOR CHANGES IN FUTURE**

## Installation

If you have installed `go` on your system you can run the following command to build and install the tool.

```

go get github.com/paulvollmer/openapi-split

```

Or you can download the latest binary from the [release github page](https://github.com/paulvollmer/openapi-split/releases).

## Usage

The philosophy behind the tool is to KISS (keep it stupid simple) at the usage.

```

openapi-split > spec.yaml

# or encode the data to json with the -f flag

openapi-split -f json > spec.json

```