https://github.com/mloberg/openapi-stitcher

Stitch together multiple files into an OpenAPI specification
https://github.com/mloberg/openapi-stitcher

openapi openapi3

Last synced: 8 days ago
JSON representation

Stitch together multiple files into an OpenAPI specification

• Host: GitHub
• URL: https://github.com/mloberg/openapi-stitcher
• Owner: mloberg
• License: mit
• Created: 2020-02-27T15:51:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-03-01T04:39:50.000Z (over 4 years ago)
• Last Synced: 2024-09-24T17:48:40.009Z (about 2 months ago)
• Topics: openapi, openapi3
• Language: JavaScript
• Homepage:
• Size: 47.9 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OpenAPI Stitcher

Stitch together OpenAPI files into a single file.

## Requirements

* NodeJS (>= 10)

## Usage

See help for all commands and options

    npx openapi-stitcher --help

    npx openapi-stitcher build --help

Stitch together files matching a pattern.

    npx openapi-stitcher build "spec/**/*.{yaml,yml}" openapi.yaml

Watch for changes and rebuild the file.

    npx openapi-stitcher build --watch "spec/**/*.{yaml,yml}" openapi.yaml

Serve the specification using [Swagger UI](https://github.com/swagger-api/swagger-ui).

    npx openapi-stitcher serve "spec/**/*.{yaml,yml}"

See _example/spec_ for an example of how to organize your files to best work

with this tool.