Skip to content

Commit

Permalink
amend README with yaml usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrzej WP committed Nov 10, 2019
1 parent ba9fa86 commit 8ac024d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ Enrich your OAS 3.0 Schema!
```
node index.js openapi.json > openapi-with-examples.json
```

Alternatively you can point it to a YAML-formatted spec:
```
curl https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml --output petstore.yaml
node index.js petstore.yaml > openapi-with-examples.json
```


Use [ReDoc](https://github.com/Redocly/redoc/) to build beautiful API doc:
```
redoc-cli bundle openapi-with-examples.json
Expand Down

0 comments on commit 8ac024d

Please sign in to comment.