openapi

Documentation

Overview

Package openapi 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 RegisterOpenAPIService(config *Config, containers *restful.Container) (err error)
• type Config

Constants

const (
	// By convention, the Swagger specification file is named swagger.json
	OpenAPIServePath = "/swagger.json"
	OpenAPIVersion   = "2.0"
)

Functions

func RegisterOpenAPIService

func RegisterOpenAPIService(config *Config, containers *restful.Container) (err error)

RegisterOpenAPIService registers a handler to provides standard OpenAPI specification.

Types

type Config

type Config struct {
	// SwaggerConfig is set of configuration for go-restful swagger spec generation. Currently
	// openAPI implementation depends on go-restful to generate models.
	SwaggerConfig *swagger.Config
	// Info is general information about the API.
	Info *spec.Info
	// DefaultResponse will be used if an operation does not have any responses listed. It
	// will show up as ... "responses" : {"default" : $DefaultResponse} in swagger spec.
	DefaultResponse *spec.Response
	// List of webservice's path prefixes to ignore
	IgnorePrefixes []string
}

Config is set of configuration for openAPI spec generation.