swag-openapi3

command module
v1.3.0 Latest Latest
Warning

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

Go to latest
Published: Jan 31, 2024 License: MIT Imports: 14 Imported by: 0

README

Swag to OpenAPI Converter

Built with ❤️

This package was created because https://github.com/swaggo/swag does not support openapi 3.0.

It is essentially a copy of swag's main.go and added kin-openapi conversion functions.

Installation

go install github.com/dimasdanz/swag-openapi3

How To

As it's just a copy, all the flag in swag's cli should work. One caveat, the outputType is hardcoded to json file because kin-openapi's converter does not work well with other type.

Run swag's comment format. Assuming GOPATH BIN is in the env's PATH

openapi fmt

Generate OpenAPI 3.0

openapi init --output out -requiredByDefault

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