https://github.com/gas-buddy/swagger-ref-resolver

A module to convert $refs in swagger to deal with tooling that can't handle composition (and gives you some extra superpowers)
https://github.com/gas-buddy/swagger-ref-resolver

Last synced: about 2 months ago
JSON representation

A module to convert $refs in swagger to deal with tooling that can't handle composition (and gives you some extra superpowers)

• Host: GitHub
• URL: https://github.com/gas-buddy/swagger-ref-resolver
• Owner: gas-buddy
• Created: 2016-09-02T17:29:25.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-05-27T20:43:36.000Z (over 4 years ago)
• Last Synced: 2024-11-20T05:02:59.894Z (about 2 months ago)
• Language: JavaScript
• Size: 189 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
swagger-ref-resolver

====================

Swagger and the swagger ecosystem are not especially well suited to

document composition. In our case, we want to group a set of related

operations into a single service/API, but they have a small but natural

set of groupings. The aggregate swagger document can be unwieldy as a single

file. The swagger-ref-resolver module allows you to create a composite

swagger doc made of multiple *valid* swagger subdocuments. For example:

```

{

    "swagger": "2.0",

    "paths": {

        "$ref": [

            "./someCoolStuff.json#paths",

            "./someBoringStuff.json#paths"

        ]

    },

    "definitions": {

        "$ref": [

            "./common.json#definitions",

            "./someCoolStuff.json#definitions",

            "./someBoringStuff.json#definitions"

        ]

    }

}

```

In the above example, someCoolStuff and someBoringStuff can be fully valid

swagger documents that can be edited in [Swagger Editor](http://editor.swagger.io).

swagger-ref-resolver can then take the root swagger doc and turn it into a

normal single-file swagger doc. It can do this at "runtime" or via a CLI 

(for example to be used in a prepublish script).