Categorygithub.com/vine-io/go-restful-openapi
repositorypackage
0.4.5
Repository: https://github.com/vine-io/go-restful-openapi.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

go-restful-openapi

Build Status GoDoc

openapi extension to the go-restful package, targeting version 3.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 modules

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

© 2024, MIT License. Contributions welcome.