https://github.com/megapixel99/yaml-readme-generator
If you use an OpenAPI 3.0 YAML Specification, you can run this NodeJS script to generate a preformatted list of the available routes and their response(s).
https://github.com/megapixel99/yaml-readme-generator
Last synced: over 1 year ago
JSON representation
If you use an OpenAPI 3.0 YAML Specification, you can run this NodeJS script to generate a preformatted list of the available routes and their response(s).
- Host: GitHub
- URL: https://github.com/megapixel99/yaml-readme-generator
- Owner: Megapixel99
- License: gpl-3.0
- Created: 2020-03-25T20:00:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-25T20:11:40.000Z (over 6 years ago)
- Last Synced: 2025-02-04T21:41:19.159Z (over 1 year ago)
- Language: JavaScript
- Size: 17.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YAML README Generator
## Purpose/Goal
If you use an OpenAPI 3.0 YAML Specification, you can run this NodeJS script to
generate a preformatted list of the available routes and their response(s).
## How to initialize the project
To initialize the project run:
```
$ npm i
```
## How to run the project
To run the project you can either run with:
```
$ npm start
```
which will look for an `api.yaml` file in the root directory of the project, or
you can run the project with:
```
$ npm start ./api.yaml ./schema.yaml ./other.yaml
```
which will look for all of the yaml files specified as command line arguments.
Upon running the project the specification for the yaml file(s), the program
will output to the Terminal/Command Prompt and will need to be copied to the
appropriate README file.
### Or
You can run the project with
```
$ node ./index.js
```
or
```
$ node ./index.js ./api.yaml ./schema.yaml ./other.yaml
```
#### Please see `ExampleOutput.md` for an example of the output, which was generated with the command:
```
$ npm start ./api.yaml ./views.yaml
```
##### Contributions are appreciated