npm

Bring the best of OSS JavaScript development to your projects with npm Orgs - private packages & team management tools.Learn more »

avantation

2.0.3 • Public • Published

Avantation

🚧 Work in Progress! 🚧

Version downloads license donation

avantation is tool the for generate OpenAPI3.0 from HTTP Archive format(HAR).

avantation is written and maintained by Anbarasan K (anbuksv@gmail.com).

Contributing

Bug reports and code and documentation patches are welcome.

Install

Direct downloads are available through the release page.

If you have Node installed on your computer just run npm install

npm install -g avantation

Features

  • HTTP sample code generation
  • Dynamic route path conversion
  • Schema generation
  • Supports json/yaml output formats
  • JWT authentication header mapping
  • Static-UI generation

Usage

Build OpenAPI specification from HAR.
 
USAGE
  $ avantation HAR
 
ARGUMENTS
  HAR  http archive(har) path
 
OPTIONS
  -b, --base-path=base-path                Separate the common path as base path from HTTP requests.
                                           Example:['api/v1']
 
  -h, --host=host                          Filter the http request from HAR and use it as server url in output.
 
  -j, --json                               Write output result in JSON format.
 
  -o, --out=out                            [default: ./openapi.yaml] Write output result at this DEST location.
 
  -r, --path-param-regex=path-param-regex  [default: [0-9]|[-$@!~%^*()_+]] Convert Regex matching params into dynamic path
 
  -s, --security-headers=security-headers  [default: {}] Map matching HTTP headers into security headers on request.
 
  -t, --template=template                  To override the default template pass the your template file location.
 
  --build-static-ui                        Build the static user interface from generated OpenAPI3.0 specification.
 
  --disable-tag                            Diable end points grouping based on route path in HAR
 
  --http-snippet                           Generate HTTP smaple code snippet for request and append it as 'x-code-sample' to OpenAPI path
                                           object.
 
  --static-ui-logo=static-ui-logo          Static-UI logo file location
 

Demo

Existing Projects

Existing Project Demo

Tools : Firefox | Chrome | Safari | Charles Proxy

New Projects

New Project Demo

Tools : Insomnia

Demo Results

install

npm i avantation

Downloadsweekly downloads

20

version

2.0.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability