openapi

package
v3.0.28 Latest Latest
Warning

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

 Go to latest Published: Nov 10, 2022 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BearerAuthSecuritySchema added in v3.0.25 

type BearerAuthSecuritySchema struct {
	Type         string `yaml:"type" json:"type"`
	Scheme       string `yaml:"scheme" json:"scheme"`
	BearerFormat string `yaml:"bearerFormat" json:"bearerFormat"`
}

type Components 

type Components struct {
	SecuritySchemes map[string]interface{} `yaml:"securitySchemes" json:"securitySchemes"`
	Schemas         Schemas                `yaml:"schemas,omitempty" json:"schemas,omitempty"`
}

func (*Components) MarshalJSON 

func (j *Components) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Components) MarshalJSONBuf 

func (j *Components) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Components) UnmarshalJSON 

func (j *Components) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Components) UnmarshalJSONFFLexer 

func (j *Components) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Contact 

type Contact struct {
	Name  string `yaml:"name,omitempty" json:"name,omitempty"`
	URL   string `yaml:"url,omitempty" json:"url,omitempty"`
	Email string `yaml:"email,omitempty" json:"email,omitempty"`
}

func (*Contact) MarshalJSON 

func (j *Contact) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Contact) MarshalJSONBuf 

func (j *Contact) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Contact) UnmarshalJSON 

func (j *Contact) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Contact) UnmarshalJSONFFLexer 

func (j *Contact) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Content 

type Content map[string]Media

type Error 

type Error struct {
	PkgName string
	PkgPath string
	Name    string
	Code    int64
	ErrCode string
}

type ExternalDocs 

type ExternalDocs struct {
	Description string `yaml:"description,omitempty" json:"description,omitempty"`
	URL         string `yaml:"url,omitempty" json:"url,omitempty"`
}

func (*ExternalDocs) MarshalJSON 

func (j *ExternalDocs) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*ExternalDocs) MarshalJSONBuf 

func (j *ExternalDocs) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*ExternalDocs) UnmarshalJSON 

func (j *ExternalDocs) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*ExternalDocs) UnmarshalJSONFFLexer 

func (j *ExternalDocs) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Info 

type Info struct {
	Title          string   `yaml:"title,omitempty" json:"title,omitempty"`
	Description    string   `yaml:"description,omitempty" json:"description,omitempty"`
	TermsOfService string   `yaml:"termsOfService,omitempty" json:"termsOfService,omitempty"`
	Contact        *Contact `yaml:"contact,omitempty" json:"contact,omitempty"`
	License        *License `yaml:"license,omitempty" json:"license,omitempty"`
	Version        string   `yaml:"version,omitempty" json:"version,omitempty"`
}

func (*Info) MarshalJSON 

func (j *Info) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Info) MarshalJSONBuf 

func (j *Info) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Info) UnmarshalJSON 

func (j *Info) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Info) UnmarshalJSONFFLexer 

func (j *Info) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Interface 

type Interface struct {
	Name      option.String
	Namespace string
	Methods   []InterfaceMethod
}

type InterfaceMethod 

type InterfaceMethod struct {
	Name             option.String
	RESTMethod       string
	RESTPath         string
	RESTQueryVars    []string
	RESTPathVars     map[string]string
	Tags             []string
	Func             *option.FuncType
	Description      string
	RESTWrapResponse string
	RESTQueryValues  []string
	RESTHeaderVars   []string
	BearerAuth       bool
}

type License 

type License struct {
	Name string `yaml:"name,omitempty" json:"name,omitempty"`
	URL  string `yaml:"url,omitempty" json:"url,omitempty"`
}

func (*License) MarshalJSON 

func (j *License) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*License) MarshalJSONBuf 

func (j *License) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*License) UnmarshalJSON 

func (j *License) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*License) UnmarshalJSONFFLexer 

func (j *License) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Media 

type Media struct {
	Schema *Schema `yaml:"schema,omitempty" json:"schema,omitempty"`
}

func (*Media) MarshalJSON 

func (j *Media) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Media) MarshalJSONBuf 

func (j *Media) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Media) UnmarshalJSON 

func (j *Media) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Media) UnmarshalJSONFFLexer 

func (j *Media) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type OpenAPI 

type OpenAPI struct {
	OpenAPI    string           `yaml:"openapi" json:"openapi"`
	Info       Info             `yaml:"info,omitempty" json:"info,omitempty"`
	Servers    []Server         `yaml:"servers,omitempty" json:"servers,omitempty"`
	Tags       []Tag            `yaml:"tags,omitempty" json:"tags,omitempty"`
	Schemes    []string         `yaml:"schemes,omitempty" json:"schemes,omitempty"`
	Paths      map[string]*Path `yaml:"paths,omitempty" json:"paths,omitempty"`
	Components Components       `yaml:"components,omitempty" json:"components,omitempty"`
}

func (*OpenAPI) MarshalJSON 

func (j *OpenAPI) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*OpenAPI) MarshalJSONBuf 

func (j *OpenAPI) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*OpenAPI) UnmarshalJSON 

func (j *OpenAPI) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*OpenAPI) UnmarshalJSONFFLexer 

func (j *OpenAPI) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Openapi 

type Openapi struct {
	// contains filtered or unexported fields
}

func NewOpenapi 

func NewOpenapi(info Info, servers []Server, interfaces []Interface, errors map[string]map[string][]Error, useJSONRPC bool) *Openapi

func (*Openapi) Build 

func (g *Openapi) Build() OpenAPI

type Operation 

type Operation struct {
	Tags        []string                   `yaml:"tags,omitempty" json:"tags,omitempty"`
	Summary     string                     `yaml:"summary,omitempty" json:"summary,omitempty"`
	Description string                     `yaml:"description,omitempty" json:"description,omitempty"`
	OperationID string                     `yaml:"operationId,omitempty" json:"operationId,omitempty"`
	Consumes    []string                   `yaml:"consumes,omitempty" json:"consumes,omitempty"`
	Produces    []string                   `yaml:"produces,omitempty" json:"produces,omitempty"`
	Parameters  []Parameter                `yaml:"parameters,omitempty" json:"parameters,omitempty"`
	RequestBody *RequestBody               `yaml:"requestBody,omitempty" json:"requestBody,omitempty"`
	Responses   Responses                  `yaml:"responses,omitempty" json:"responses,omitempty"`
	Security    []map[string][]interface{} `yaml:"security" json:"security"`
}

func (*Operation) MarshalJSON 

func (j *Operation) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Operation) MarshalJSONBuf 

func (j *Operation) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Operation) UnmarshalJSON 

func (j *Operation) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Operation) UnmarshalJSONFFLexer 

func (j *Operation) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Parameter 

type Parameter struct {
	Ref         string  `yaml:"$ref,omitempty" json:"$ref,omitempty"`
	In          string  `yaml:"in,omitempty" json:"in,omitempty"`
	Name        string  `yaml:"name,omitempty" json:"name,omitempty"`
	Description string  `yaml:"description,omitempty" json:"description,omitempty"`
	Required    bool    `yaml:"required,omitempty" json:"required,omitempty"`
	Schema      *Schema `yaml:"schema,omitempty" json:"schema,omitempty"`
}

func (*Parameter) MarshalJSON 

func (j *Parameter) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Parameter) MarshalJSONBuf 

func (j *Parameter) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Parameter) UnmarshalJSON 

func (j *Parameter) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Parameter) UnmarshalJSONFFLexer 

func (j *Parameter) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Path 

type Path struct {
	Ref         string     `yaml:"$ref,omitempty" json:"$ref,omitempty"`
	Summary     string     `yaml:"summary,omitempty" json:"summary,omitempty"`
	Description string     `yaml:"description,omitempty" json:"description,omitempty"`
	Get         *Operation `yaml:"get,omitempty" json:"get,omitempty"`
	Post        *Operation `yaml:"post,omitempty" json:"post,omitempty"`
	Patch       *Operation `yaml:"patch,omitempty" json:"patch,omitempty"`
	Put         *Operation `yaml:"put,omitempty" json:"put,omitempty"`
	Delete      *Operation `yaml:"delete,omitempty" json:"delete,omitempty"`
}

func (*Path) MarshalJSON 

func (j *Path) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Path) MarshalJSONBuf 

func (j *Path) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Path) UnmarshalJSON 

func (j *Path) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Path) UnmarshalJSONFFLexer 

func (j *Path) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Properties 

type Properties map[string]*Schema

type RequestBody 

type RequestBody struct {
	Description string  `yaml:"description,omitempty" json:"description,omitempty"`
	Content     Content `yaml:"content,omitempty" json:"content,omitempty"`
	Required    bool    `yaml:"required,omitempty" json:"required,omitempty"`
}

func (*RequestBody) MarshalJSON 

func (j *RequestBody) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*RequestBody) MarshalJSONBuf 

func (j *RequestBody) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*RequestBody) UnmarshalJSON 

func (j *RequestBody) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*RequestBody) UnmarshalJSONFFLexer 

func (j *RequestBody) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Response 

type Response struct {
	Description string  `yaml:"description,omitempty" json:"description,omitempty"`
	Content     Content `yaml:"content,omitempty" json:"content,omitempty"`
}

func (*Response) MarshalJSON 

func (j *Response) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Response) MarshalJSONBuf 

func (j *Response) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Response) UnmarshalJSON 

func (j *Response) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Response) UnmarshalJSONFFLexer 

func (j *Response) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Responses 

type Responses map[string]*Response

type Schema 

type Schema struct {
	Description string      `yaml:"description,omitempty" json:"description,omitempty"`
	Ref         string      `yaml:"$ref,omitempty" json:"$ref,omitempty"`
	Type        string      `yaml:"type,omitempty" json:"type,omitempty"`
	Nullable    bool        `yaml:"nullable,omitempty" json:"nullable,omitempty"`
	Format      string      `yaml:"format,omitempty" json:"format,omitempty"`
	Properties  Properties  `yaml:"properties,omitempty" json:"properties,omitempty"`
	Items       *Schema     `yaml:"items,omitempty" json:"items,omitempty"`
	AnyOf       []Schema    `yaml:"anyOf,omitempty" json:"anyOf,omitempty"`
	Enum        []string    `yaml:"enum,omitempty" json:"enum,omitempty"`
	Example     interface{} `yaml:"example,omitempty" json:"example,omitempty"`
}

func (*Schema) MarshalJSON 

func (j *Schema) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Schema) MarshalJSONBuf 

func (j *Schema) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Schema) UnmarshalJSON 

func (j *Schema) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Schema) UnmarshalJSONFFLexer 

func (j *Schema) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Schemas 

type Schemas map[string]*Schema

type Server 

type Server struct {
	URL         string              `yaml:"url,omitempty" json:"url,omitempty"`
	Description string              `yaml:"description,omitempty" json:"description,omitempty"`
	Variables   map[string]Variable `yaml:"variables,omitempty" json:"variables,omitempty"`
}

func (*Server) MarshalJSON 

func (j *Server) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Server) MarshalJSONBuf 

func (j *Server) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Server) UnmarshalJSON 

func (j *Server) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Server) UnmarshalJSONFFLexer 

func (j *Server) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Tag 

type Tag struct {
	Name         string       `yaml:"name,omitempty" json:"name,omitempty"`
	Description  string       `yaml:"description,omitempty" json:"description,omitempty"`
	ExternalDocs ExternalDocs `yaml:"externalDocs,omitempty" json:"externalDocs,omitempty"`
}

func (*Tag) MarshalJSON 

func (j *Tag) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Tag) MarshalJSONBuf 

func (j *Tag) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Tag) UnmarshalJSON 

func (j *Tag) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Tag) UnmarshalJSONFFLexer 

func (j *Tag) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

type Variable 

type Variable struct {
	Enum        []string `yaml:"enum,omitempty" json:"enum,omitempty"`
	Default     string   `yaml:"default,omitempty" json:"default,omitempty"`
	Description string   `yaml:"description,omitempty" json:"description,omitempty"`
}

func (*Variable) MarshalJSON 

func (j *Variable) MarshalJSON() ([]byte, error)

MarshalJSON marshal bytes to json - template

func (*Variable) MarshalJSONBuf 

func (j *Variable) MarshalJSONBuf(buf fflib.EncodingBuffer) error

MarshalJSONBuf marshal buff to json - template

func (*Variable) UnmarshalJSON 

func (j *Variable) UnmarshalJSON(input []byte) error

UnmarshalJSON umarshall json - template of ffjson

func (*Variable) UnmarshalJSONFFLexer 

func (j *Variable) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error

UnmarshalJSONFFLexer fast json unmarshall - template ffjson

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.