swaggergen

command
v0.0.0-...-dfab029 Latest Latest
Warning

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

Go to latest
Published: Nov 30, 2023 License: MIT Imports: 15 Imported by: 0

README

SwaggerGen

SwaggerGen can generate Swagger/OpenAPI Specification from proxify's request and response logs.

Installation

Download the latest, ready-to-run binary from under releases or install/build it using Go:

go install -v github.com/projectdiscovery/proxify/cmd/swaggergen@latest

Usage

swaggergen -help

Usage:
  ./swaggergen [flags]

Flags:
   -log-dir string           path to proxify's output log directory
   -api, -api-host string    API host (example: api.example.com)
   -os, -output-spec string  file to store Swagger/OpenAPI specification (example: OpenAPI.yaml)
Running SwaggerGen

The following command generates and saves the Swagger/OpenAPI specification in OpenAPI.yaml, from the requests and responses captured for localhost:8080 and stored in the logs directory:

swaggergen -api localhost:8080 -log-dir ./logs -os OpenAPI.yaml

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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