GitHub - emicklei/go-restful-openapi: OpenAPI extension in Go for the go-restful package (original) (raw)

go-restful-openapi

openapi extension to the go-restful package, targeting version 2.0

The following Go field tags are translated to OpenAPI equivalents

description
minimum
maximum
optional ( if set to "true" then it is not listed in required)
unique
modelDescription
type (overrides the Go type String())
enum
readOnly

See TestThatExtraTagsAreReadIntoModel for examples.

dependencies

go-restful
go-openapi

Go modules

Versions v1 of this package require Go module version v2 of the go-restful package. To use version v3 of the go-restful package, you need to import v2 of this package, such as:

import (
    restfulspec "github.com/emicklei/go-restful-openapi/v2"
    restful "github.com/emicklei/go-restful/v3"
)