https://github.com/binded/build-swagger

build-swagger
https://github.com/binded/build-swagger

Last synced: about 5 hours ago
JSON representation

build-swagger

• Host: GitHub
• URL: https://github.com/binded/build-swagger
• Owner: binded
• License: mit
• Created: 2016-10-18T19:24:41.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-10-18T20:14:04.000Z (about 8 years ago)
• Last Synced: 2024-10-22T22:43:16.842Z (26 days ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 1
• Watchers: 9
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# build-swagger

[![Build Status](https://travis-ci.org/blockai/build-swagger.svg?branch=master)](https://travis-ci.org/blockai/build-swagger)

Simple wrapper around [swagger-jsdoc](https://github.com/Surnet/swagger-jsdoc)

Builds a swagger.json based on a swagger.js specification file. By

default, tries to find `swagger.js` in `./swagger.js` and

`./src/swagger.js` and writes to `./swagger.json`.

## Install

```bash

npm install --save build-swagger

```

Requires Node v6+

## Usage

See [./test](./test) directory for usage examples.

```bash

build-swagger [--spec] [--jsonPath]

# by default, spec looks for ./swagger.js or ./src/swagger.js

# if jsonPath is not specified, it will output to stdout

# example:

build-swagger.js --spec ./src/swagger.js --jsonPath myswagger.json

```