https://github.com/anbuksv/avantation

Build OpenAPI3.0 specification from HAR.
https://github.com/anbuksv/avantation

api-documentation api-documentation-tool avantation documentation-generator documentation-tool openapi redoc static-site-generator swagger-ui

Last synced: about 2 months ago
JSON representation

Build OpenAPI3.0 specification from HAR.

• Host: GitHub
• URL: https://github.com/anbuksv/avantation
• Owner: anbuksv
• License: mit
• Created: 2018-12-17T03:17:54.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-12T21:04:59.000Z (over 1 year ago)
• Last Synced: 2024-08-13T03:07:24.396Z (5 months ago)
• Topics: api-documentation, api-documentation-tool, avantation, documentation-generator, documentation-tool, openapi, redoc, static-site-generator, swagger-ui
• Language: TypeScript
• Homepage: https://avantation.in
• Size: 12.5 MB
• Stars: 82
• Watchers: 2
• Forks: 15
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - anbuksv/avantation - Build OpenAPI3.0 specification from HAR. (TypeScript)

README

        
Avantation







  

    

  

  

    

  

  

    

  

  

    

  



avantation is a tool to generate an OpenAPI 3.0 specification from HTTP Archive format(HAR).

avantation is written and maintained by Anbarasan K ([email protected]).



  


   Project home page: https://www.avantation.in/ 

  

  


   Code home page: https://github.com/anbuksv/avantation

  

  


   Issue tracker: https://github.com/anbuksv/avantation/issues

  



## Contributing

Bug reports and code and documentation patches are welcome.

## Install

Direct downloads are available through the [release page](https://github.com/anbuksv/avantation/releases/latest).

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

```sh-session

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.

  --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.

```

## Demo

### Existing Projects

![Existing Project Demo](demo/Existing_Project_Demo.gif)

**Tools** : [Firefox](https://www.mozilla.org/en-US/firefox/new/) | [Chrome](https://www.google.com/chrome/) | [Safari](https://www.apple.com/safari/) | [Charles Proxy](https://www.charlesproxy.com/)

### New Projects

![New Project Demo](demo/New_Project_Demo.gif)

**Tools** : [Insomnia](https://insomnia.rest/download/)

## User Interface's





  





  





# FAQ

How to generate Static-UI?

      avantation-ui bash script will help you to build static user interface for your specs but it's required redoc-cli.