Documentation
¶
Overview ¶
Package genopenapi provides a code generator for OpenAPI v2.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddErrorDefs ¶
func AddErrorDefs(reg *descriptor.Registry) error
AddErrorDefs Adds google.rpc.Status and google.protobuf.Any to registry (used for error-related API responses)
func LookupNamingStrategy ¶ added in v2.6.0
LookupNamingStrategy looks up the given naming strategy and returns the naming strategy function for it. The naming strategy function takes in the list of all fully-qualified proto message names, and returns a mapping from fully-qualified name to OpenAPI name.
Types ¶
type ContentEncoder ¶ added in v2.9.0
type ContentEncoder interface {
Encode(v interface{}) (err error)
}
type Format ¶ added in v2.9.0
type Format string
func (Format) NewEncoder ¶ added in v2.9.0
func (f Format) NewEncoder(w io.Writer) (ContentEncoder, error)
type GeneratorOptions ¶ added in v2.4.0
type GeneratorOptions struct {
Registry *descriptor.Registry
RecursiveDepth int
}
type RawExample ¶ added in v2.9.0
type RawExample json.RawMessage
func (RawExample) MarshalJSON ¶ added in v2.9.0
func (m RawExample) MarshalJSON() ([]byte, error)
func (RawExample) MarshalYAML ¶ added in v2.9.0
func (e RawExample) MarshalYAML() (interface{}, error)
MarshalYAML implements yaml.Marshaler interface.
It converts RawExample to one of yaml-supported types and returns it.
From yaml.Marshaler docs: The Marshaler interface may be implemented by types to customize their behavior when being marshaled into a YAML document. The returned value is marshaled in place of the original value implementing Marshaler.
func (*RawExample) UnmarshalJSON ¶ added in v2.9.0
func (m *RawExample) UnmarshalJSON(data []byte) error
Source Files