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 (
	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 {
	// Path to the spec file. by convention, it should name [.*/]*/swagger.json
	OpenAPIServePath string
	// List of web services for this API spec
	WebServices []*restful.WebService

	// List of supported protocols such as https, http, etc.
	ProtocolList []string

	// 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 the spec.
	DefaultResponse *spec.Response
	// List of webservice's path prefixes to ignore
	IgnorePrefixes []string

	// OpenAPIDefinitions should provide definition for all models used by routes. Failure to provide this map
	// or any of the models will result in spec generation failure.
	OpenAPIDefinitions *common.OpenAPIDefinitions
}

Config is set of configuration for openAPI spec generation.