api

package

Go to main page

Versions in this module

v0

v0.6.0

Apr 11, 2025

Changes in this version

type ContentType

+ const ContentTypeBMP

+ const ContentTypeCSV

+ const ContentTypeExcel

+ const ContentTypeForm

+ const ContentTypeFormData

+ const ContentTypeGIF

+ const ContentTypeGZIP

+ const ContentTypeJPEG

+ const ContentTypeMP3

+ const ContentTypeMP4

+ const ContentTypeMPEG

+ const ContentTypePNG

+ const ContentTypePower

+ const ContentTypeSVG

+ const ContentTypeStream

+ const ContentTypeWAV

+ const ContentTypeWord

+ const ContentTypeZIP

type DataType

+ const DataTypeFile

type Schema

+ FileType ContentType

+ func (s Schema) ContentType() ContentType

v0.5.0

Apr 10, 2025

v0.4.0

Apr 9, 2024

v0.3.4

Apr 7, 2024

Changes in this version

+ func GetSchemaType(valueOrType any) reflect.Type

+ type HasSchemaType interface

+ APISchemaType func() any

v0.3.3

Apr 5, 2024

Changes in this version

+ func SetName[V any](build *Builder, name string)

type Builder

+ Names map[reflect.Type]string

+ func (build *Builder) SetName(typ reflect.Type, name string)

+ func (build *Builder) SetNameOf(val any, name string)

v0.3.2

Apr 5, 2024

Changes in this version

+ var KindToFormat = map[reflect.Kind]string

+ func AddSchema[V any](build *Builder)

type Builder

+ MapIsNullable bool

+ SliceIsNullable bool

+ func (build *Builder) AddSchemaOf(val any)

+ func (build *Builder) GetSchemaOf(v any) *Schema

+ func (build *Builder) SetBaseSchemaOf(v any, s *Schema)

+ func (build *Builder) SetFullSchemaOf(v any, s *Schema)

type Schema

+ func SchemaOf[V any](build *Builder) *Schema

+ func SchemaRef(name string) *Schema

v0.3.1

Apr 3, 2024

v0.3.0

Apr 2, 2024

v0.2.2

Apr 2, 2024

v0.2.1

Apr 2, 2024

v0.2.0

Apr 2, 2024

v0.1.0

Dec 1, 2022

Changes in this version

+ var FormatRegex map[string]*regexp.Regexp = map[string]*regexp.Regexp

+ func Any(val any) *any

+ func ApplyOptions(s *Schema, tag string)

+ func EscapePathPart(s string) string

+ func GetDescription(valueOrType any) string

+ func GetEnums(valueOrType any) []any

+ func GetExample(valueOrType any) *any

+ func GetJSONOptions(field reflect.StructField) (property string, optional bool, skip bool)

+ func GetName(valueOrType any) string

+ func GetNameQualified(valueOrType any) string

+ func GetOperationUpdate(fnOrType any, op *Operation) bool

+ func GetType(valueOrType any) reflect.Type

+ func IsNamedType(valueOrType any) bool

+ func Merge(base T, next T, additional ...T) T

+ func MergeCanMerge(base *V, next *V) *V

+ func MergeMap(base map[K]V, next map[K]V) map[K]V

+ func MergeSlice(base []V, next []V) []V

+ func MergeSliceReplace(base []V, next []V) []V

+ func MergeSliceUnique(base []V, next []V) []V

+ func MergeValue(base V, next V) V

+ func Ref(name string) V

+ func SetBaseSchema(build *Builder, s *Schema)

+ func SetFullSchema(build *Builder, s *Schema)

+ type BoolSchema struct

+ Bool *bool

+ Schema *Schema

+ func SchemaForBool(b bool) *BoolSchema

+ func SchemaForSchema(s *Schema) *BoolSchema

+ func (bs *BoolSchema) UnmarshalJSON(data []byte) error

+ func (bs BoolSchema) MarshalJSON() ([]byte, error)

+ type Builder struct

+ BaseSchema map[reflect.Type]*Schema

+ Collisions map[reflect.Type]*Schema

+ Document Document

+ FullSchema map[reflect.Type]*Schema

+ NullableIsOptional bool

+ OptionalIsNullable bool

+ func NewBuilder() *Builder

+ func (build *Builder) AddExample(name string, ex *Example)

+ func (build *Builder) AddHeader(name string, header *Header)

+ func (build *Builder) AddLink(name string, link *Link)

+ func (build *Builder) AddParameter(name string, param *Parameter)

+ func (build *Builder) AddPath(url string, path *Path)

+ func (build *Builder) AddRequestBody(name string, body *RequestBody)

+ func (build *Builder) AddResponse(name string, response *Response)

+ func (build *Builder) AddSchema(typ reflect.Type)

+ func (build *Builder) AddSecurity(name string, security *Security)

+ func (build *Builder) AddTag(tag Tag)

+ func (build *Builder) Build() Document

+ func (build *Builder) BuildJSON() []byte

+ func (build *Builder) BuildSchema(typ reflect.Type, addToDocument bool) *Schema

+ func (build *Builder) GetExample(name string) *Example

+ func (build *Builder) GetHeader(name string) *Header

+ func (build *Builder) GetInnerSchema(s Schema) *Schema

+ func (build *Builder) GetLink(name string) *Link

+ func (build *Builder) GetParameter(name string) *Parameter

+ func (build *Builder) GetPath(url string) *Path

+ func (build *Builder) GetRequestBody(name string) *RequestBody

+ func (build *Builder) GetResponse(name string) *Response

+ func (build *Builder) GetSchema(typ reflect.Type) *Schema

+ func (build *Builder) GetSecurity(name string) *Security

+ func (build *Builder) IsNullable(s Schema) bool

+ func (build *Builder) RefExample(name string) *Example

+ func (build *Builder) RefHeader(name string) *Header

+ func (build *Builder) RefLink(name string) *Link

+ func (build *Builder) RefParameter(name string) *Parameter

+ func (build *Builder) RefPath(url string) *Path

+ func (build *Builder) RefRequestBody(name string) *RequestBody

+ func (build *Builder) RefResponse(name string) *Response

+ func (build *Builder) RefSecurity(name string) *Security

+ type Callbacks map[string]map[string]Path

+ type CanMerge interface

+ Merge func(value T) T

+ type CanReplace interface

+ IsUnique func(value T) bool

+ type Component struct

+ Callbacks Callbacks

+ Examples Examples

+ Headers Headers

+ Links Links

+ Parameters map[string]Parameter

+ RequestBodies map[string]RequestBody

+ Responses Responses

+ Schemas map[string]Schema

+ SecuritySchemes map[string]Security

+ func (base Component) Merge(next Component) Component

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ func (base Contact) Merge(next Contact) Contact

+ type ContentType string

+ const ContentTypeAny

+ const ContentTypeHTML

+ const ContentTypeJSON

+ const ContentTypeNone

+ const ContentTypeText

+ const ContentTypeXML

+ type Contents map[ContentType]*MediaType

+ type DataType string

+ const DataTypeArray

+ const DataTypeBoolean

+ const DataTypeInteger

+ const DataTypeNull

+ const DataTypeNumber

+ const DataTypeObject

+ const DataTypeString

+ type Discriminator struct

+ Mapping map[string]string

+ PropertyName string

+ type Document struct

+ Components *Component

+ ExternalDocs *ExternalDoc

+ Info Info

+ OpenAPI string

+ Paths map[string]Path

+ Security []Security

+ Servers []Server

+ Tags []Tag

+ func (base Document) Merge(next Document) Document

+ type Encoding struct

+ AllowReserved bool

+ ContentType string

+ Explode bool

+ Headers Headers

+ Style Style

+ type Encodings map[string]Encoding

+ type Example struct

+ Description string

+ ExternalValue string

+ Summary string

+ Value *any

+ func (hr *Example) SetReference(ref string)

+ func (hr Example) GetName() *string

+ func (hr Example) GetReference() *Reference

+ func (hr Example) GetReferencePrefix() string

+ type Examples map[string]Example

+ func GetExamples(valueOrType any, contentType ContentType) Examples

+ type ExternalDoc struct

+ Description string

+ URL string

+ type HasBaseSchema interface

+ APIBaseSchema func() *Schema

+ type HasDescription interface

+ APIDescription func() string

+ type HasEnum interface

+ APIEnum func() []any

+ type HasExample interface

+ APIExample func() *any

+ type HasExamples interface

+ APIExamples func(contentType ContentType) Examples

+ type HasFullSchema interface

+ APIFullSchema func() *Schema

+ type HasName interface

+ APIName func() string

+ type HasOperation interface

+ APIOperation func() Operation

+ type HasOperationUpdate interface

+ APIOperationUpdate func(op *Operation)

+ type HasReference interface

+ GetReference func() *Reference

+ GetReferencePrefix func() string

+ SetReference func(ref string)

+ type Header struct

+ func (base Header) Merge(next Header) Header

+ func (hr *Header) SetReference(ref string)

+ func (hr Header) GetReference() *Reference

+ type Headers map[string]*Header

+ type Info struct

+ Contact *Contact

+ Description string

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ func (base Info) Merge(next Info) Info

+ type License struct

+ Name string

+ URL string

+ func (base License) Merge(next License) License

+ type Link struct

+ Description string

+ OperationId string

+ OperationRef string

+ Parameters map[string]any

+ RequestBody *any

+ Server *Server

+ func (hr *Link) SetReference(ref string)

+ func (hr Link) GetName() *string

+ func (hr Link) GetReference() *Reference

+ func (hr Link) GetReferencePrefix() string

+ type Links map[string]Link

+ type MediaType struct

+ Encoding Encodings

+ Example *any

+ Examples Examples

+ Schema *Schema

+ type Operation struct

+ Callbacks Callbacks

+ Deprecated bool

+ Description string

+ ExternalDocs *ExternalDoc

+ OperationID string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Responses Responses

+ Security []SecurityRequirement

+ Servers []Server

+ Summary string

+ Tags []string

+ func GetOperation(fnOrType any) *Operation

+ func (base Operation) Merge(next Operation) Operation

+ func (op *Operation) AddParameters(build *Builder, in ParameterIn, typ reflect.Type)

+ func (op *Operation) GetParameters(in ParameterIn) []Parameter

+ func (op *Operation) GetParametersSchema(in ParameterIn) Schema

+ type Parameter struct

+ In ParameterIn

+ Name string

+ func (base Parameter) IsUnique(next Parameter) bool

+ func (base Parameter) Merge(next Parameter) Parameter

+ func (hr *Parameter) SetReference(ref string)

+ func (hr Parameter) GetName() *string

+ func (hr Parameter) GetReference() *Reference

+ func (hr Parameter) GetReferencePrefix() string

+ type ParameterBase struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ Content Contents

+ Deprecated bool

+ Description string

+ Example *any

+ Examples map[string]any

+ Explode bool

+ Required bool

+ Schema *Schema

+ Style Style

+ func (base ParameterBase) Merge(next ParameterBase) ParameterBase

+ type ParameterIn string

+ const ParameterInCookie

+ const ParameterInHeader

+ const ParameterInPath

+ const ParameterInQuery

+ type Path struct

+ Delete *Operation

+ Description string

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []Parameter

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Servers []Server

+ Summary string

+ Trace *Operation

+ func (base Path) Merge(next Path) Path

+ func (hr *Path) SetReference(ref string)

+ func (hr Path) GetName() *string

+ func (hr Path) GetReference() *Reference

+ func (hr Path) GetReferencePrefix() string

+ type Reference struct

+ Ref string

+ func RefTo(canRef HasReference, name string) *Reference

+ func (hr *Reference) GetReference() *Reference

+ func (hr *Reference) SetReference(ref string)

+ func (hr Reference) GetReferencePrefix() string

+ type RequestBody struct

+ Content Contents

+ Description string

+ Required bool

+ func (base RequestBody) Merge(next RequestBody) RequestBody

+ func (hr *RequestBody) SetReference(ref string)

+ func (hr RequestBody) GetName() *string

+ func (hr RequestBody) GetReference() *Reference

+ func (hr RequestBody) GetReferencePrefix() string

+ type Response struct

+ Content Contents

+ Description string

+ Headers Headers

+ Links Links

+ func (base Response) Merge(next Response) Response

+ func (hr *Response) SetReference(ref string)

+ func (hr Response) GetName() *string

+ func (hr Response) GetReference() *Reference

+ func (hr Response) GetReferencePrefix() string

+ type Responses map[string]*Response

+ type Schema struct

+ AdditionalProperties *BoolSchema

+ AllOf []Schema

+ AnyOf []Schema

+ Default *any

+ Deprecated bool

+ Description string

+ Discriminator *Discriminator

+ Enum []any

+ Example *any

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ ExternalDocs *ExternalDoc

+ Format string

+ Items *Schema

+ MaxItems int

+ MaxLength int

+ MaxProperties int

+ Maximum *int

+ MinItems *int

+ MinLength *int

+ MinProperties *int

+ Minimum *int

+ MultipleOf int

+ Not *Schema

+ Nullable bool

+ OneOf []Schema

+ Pattern string

+ Properties map[string]Schema

+ ReadOnly bool

+ Required []string

+ Title string

+ Type DataType

+ UniqueItems bool

+ WriteOnly bool

+ XML *XML

+ func GetSchema(valueOrType any) (*Schema, bool)

+ func (base Schema) Merge(next Schema) Schema

+ func (hr *Schema) AsReference() *Schema

+ func (hr *Schema) SetReference(ref string)

+ func (hr Schema) GetReference() *Reference

+ func (hr Schema) GetReferencePrefix() string

+ func (s *Schema) GetPattern() *regexp.Regexp

+ func (s *Schema) ResolveReference() *Schema

+ func (s Schema) GetName() *string

+ type Security struct

+ BearerFormat string

+ Description string

+ Flows any

+ In ParameterIn

+ Name string

+ OpenIdConnectUrl string

+ Scheme string

+ Type SecurityType

+ func (base Security) IsUnique(next Security) bool

+ func (hr *Security) SetReference(ref string)

+ func (hr Security) GetName() *string

+ func (hr Security) GetReference() *Reference

+ func (hr Security) GetReferencePrefix() string

+ type SecurityRequirement map[string][]string

+ type SecurityType string

+ const SecurityTypeApiKey

+ const SecurityTypeHTTP

+ const SecurityTypeOauth2

+ const SecurityTypeOpenIDConnect

+ type Server struct

+ Description string

+ URL string

+ Variables ServerVariables

+ func (base Server) IsUnique(next Server) bool

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ type ServerVariables map[string]ServerVariable

+ type Style string

+ const ParameterStyleDeepObject

+ const ParameterStyleForm

+ const ParameterStyleLabel

+ const ParameterStyleMatrix

+ const ParameterStylePipeDelimited

+ const ParameterStyleSimple

+ const ParameterStyleSpaceDelimited

+ type Tag struct

+ Description string

+ ExternalDocs *ExternalDoc

+ Name string

+ func (base Tag) IsUnique(next Tag) bool

+ type XML struct

+ Attribute bool

+ Name string

+ Namespace string

+ Prefix string

+ Wrapped bool

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