Function New

http/codegen/openapi/v3/builder.go:28–62

New returns the OpenAPI v3 specification for the given API. It returns nil if the design does not define HTTP endpoints.

(root *expr.RootExpr)

// New returns the OpenAPI v3 specification for the given API.
// It returns nil if the design does not define HTTP endpoints.
func New(root *expr.RootExpr) *OpenAPI {
	if root == nil || root.API == nil || root.API.HTTP == nil || len(root.API.HTTP.Services) == 0 {
		// No HTTP transport
		return nil
	}

	m, ok := root.API.Meta.Last("openapi:example")
	if !ok {
		m, ok = root.API.Meta.Last("swagger:example")
	}
	if ok && m == "false" {
		root.API.ExampleGenerator.Randomizer = nil
	}

	var (
		bodies, types = buildBodyTypes(root.API, root.Types, root.ResultTypes)

		info     = buildInfo(root.API)
		comps    = buildComponents(root, types)
		servers  = buildServers(root.API.Servers)
		paths    = buildPaths(root.API.HTTP, bodies, root.API)
		security = buildSecurityRequirements(root.API.Requirements)
		tags     = buildTags(root.API)
	)

	return &OpenAPI{
		OpenAPI:    OpenAPIVersion,
		Info:       info,
		Components: comps,
		Paths:      paths,
		Servers:    servers,
		Security:   security,
		Tags:       tags,
	}
}

// buildInfo builds the OpenAPI Info object.
func buildInfo(api *expr.APIExpr) *Info {