builder

package
Version: v0.0.0-...-d88c8b5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 9, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

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

View Source
const (
	OpenAPIVersion = "2.0"
)

Variables

This section is empty.

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(webServices []*restful.WebService, config *common.Config) (*spec.Swagger, error)

BuildOpenAPISpec builds OpenAPI spec given a list of webservices (containing routes) and common.Config to customize it.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL