https://github.com/christianrich/build-swagger-defs
AMP Swagger definitions
https://github.com/christianrich/build-swagger-defs
swagger swagger-docs swagger-spec
Last synced: about 1 month ago
JSON representation
AMP Swagger definitions
- Host: GitHub
- URL: https://github.com/christianrich/build-swagger-defs
- Owner: ChristianRich
- Created: 2017-05-25T05:41:34.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-26T01:25:39.000Z (almost 8 years ago)
- Last Synced: 2025-03-22T10:48:11.244Z (about 1 month ago)
- Topics: swagger, swagger-docs, swagger-spec
- Language: JavaScript
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Example of how to build Swagger definitions from multiple files
Generates a single Swagger definition files from multple files by following JSON $ref tags.
Outputs the result to /output in both JSON and YAML.
# Prerequisites
Node v.6.4 or later
# Usage
Generate the Swagger file outputting in either JSON or YAML.
If output is not specified it defaults to JSON.
`node swagger`
Will validate the file after generation and output any Swagger errors to console.
The Swagger definitions are read from /src/index.yaml and the generated files are saved to /output