builder

Documentation

Overview

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

Index

• Constants
• func BuildOpenAPIDefinitionsForResource(model interface{}, config *common.Config) (*spec.Definitions, error)
• func BuildOpenAPIDefinitionsForResources(config *common.Config, names ...string) (*spec.Swagger, error)
• func BuildOpenAPISpec(routeContainers []*restful.WebService, config *common.Config) (*spec.Swagger, error)
• func BuildOpenAPISpecFromRoutes(routeContainers []common.RouteContainer, config *common.Config) (*spec.Swagger, error)

Constants

const (
	OpenAPIVersion = "2.0"
)

Functions

func BuildOpenAPIDefinitionsForResource

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

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

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

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.