openapi

package
v1.5.0-alpha.1 Latest Latest
Warning

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

Go to latest
Published: Oct 11, 2016 License: Apache-2.0 Imports: 9 Imported by: 0

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

View Source
const (
	OpenAPIVersion = "2.0"
)

Variables

This section is empty.

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.

Directories

Path Synopsis
package common holds shared codes and types between open API code generator and spec generator.
package common holds shared codes and types between open API code generator and spec generator.

Jump to

Keyboard shortcuts

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