builder

package

v0.0.0-...-dc4e619 Latest Latest Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 13 Imported by: 74

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package builder contains code to generate OpenAPI discovery spec (which initial version of it also known as Swagger 2.0). For more details: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

View Source

const (
	OpenAPIVersion = "2.0"
)

This section is empty.

func BuildOpenAPIDefinitionsForResource(model interface{}, config *common.Config) (*spec.Definitions, error)

BuildOpenAPIDefinitionsForResource builds a partial OpenAPI spec given a sample object and common.Config to customize it.

func BuildOpenAPIDefinitionsForResources(config *common.Config, names ...string) (*spec.Swagger, error)

BuildOpenAPIDefinitionsForResources returns the OpenAPI spec which includes the definitions for the passed type names.

func BuildOpenAPISpec(routeContainers []*restful.WebService, config *common.Config) (*spec.Swagger, error)

BuildOpenAPISpec builds OpenAPI spec given a list of route containers and common.Config to customize it.

Deprecated: BuildOpenAPISpecFromRoutes should be used instead.

func BuildOpenAPISpecFromRoutes(routeContainers []common.RouteContainer, config *common.Config) (*spec.Swagger, error)

BuildOpenAPISpecFromRoutes builds OpenAPI spec given a list of route containers and common.Config to customize it.

This section is empty.