spatcher

Motivation

The company I work for uses Swashbuckle to generate OpenAPI docs for our ASP.Net applications, but it fails to generate usable output in combintation with OData. In order to offer our customers a usable documentation I created this tool to create patches for the JSON swagger file as we need them.

Install

You can install the tool globally using npm:

npm config set @flexwie:registry https://npm.pkg.github.com
npm i -g @flexwie/spatch

This will also install the spatch library globally so you can use the imports in your patches.

Usage

Create your first migration:

spatch add MyFirstPatch

This will create a patch in the patches folder and open your editor to edit it. You can customize the location of your patches with -p.

Then apply the pacthes to your swagger file:

spatch patch

You can specify the patch location (-p), the the output location (-o) and the input (-i). Your swagger input can either be a local file (prefixed by 'file://') or a remote url.