openapi-route-optimiser

command module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 22, 2024 License: MIT Imports: 2 Imported by: 0

README

Go

OpenAPI Route Optimiser

This project is a tool for extracting and optimising routing rules for an OpenAPI yaml specification.

Usage

$ ./openapi-route-optimiser --help

Usage:
  main [OPTIONS]

Application Options:
  -s, --spec=     Path to the openapi file (default: openapi.yaml)
  -d, --debug     Should the program emit debug logs on stderr
      --filter=   Filter operationId tags using a regular expression. Executes before find and replace actions occour
      --find=     Find sub-strings by regular expression to select for replacement
      --replace=  Replace found sub-strings with the given string. Supports capture groups from the regex
  -t, --template= Path to a go template file to format the output

Help Options:
  -h, --help      Show this help message

Installation

From source
git clone https://github.com/JoeReid/openapi-route-optimiser.git
cd openapi-route-optimiser
go build

This will create a openapi-route-optimiser binary in the current directory.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL