openapi2curl
Convert OpenAPI 3.0 to cURL examples
Last updated 10 months ago by cbetta .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install openapi2curl 
SYNC missed versions from official npm registry.

openapi2curl

Convert OpenAPI 3.0 to simple cURL examples.

oclif Version Downloads/week License

Installation

npm install -g openapi2curl

Usage

USAGE
  $ openapi2curl

OPTIONS
  -h, --help           show CLI help
  -i, --input=input    (required) the input OpenAPI 3.X file
  -o, --output=output  [default: curl.md] the output file to write samples to
  -v, --version        show CLI version
  -x, --hiddenTag      Embed the operateionIDs as hidden comments in the markdown

Examples

Loading from a remote URL:

openapi2curl -i https://opensource.box.com/box-openapi/openapi.json -o README.md

Loading from a local URL:

openapi2curl -i ./openapi.json -o CURL.md

Limitations

  • This project is currently mostly untested.
  • It only works with OpenAPI 3.0 JSON files.
  • It does not support splitting the docs into multiple files
  • It still has issues with rendering binary content in the request body

Current Tags

  • 0.2.0                                ...           latest (10 months ago)

2 Versions

  • 0.2.0                                ...           10 months ago
  • 0.1.0                                ...           10 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 2
Dev Dependencies (3)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |