openapi

package

Go to main page

Versions in this module

v0

v0.2.12

Dec 17, 2024

v0.2.11

Jul 10, 2024

v0.2.10

May 2, 2024

v0.2.9

May 2, 2024

Changes in this version

+ const MIMEApplicationTOML

+ const MIMEApplicationTOMLCharsetUTF8

+ const MIMEApplicationYAML

+ const MIMEApplicationYAMLCharsetUTF8

+ func AddUtf8Charset(m string) string

v0.2.8

Apr 27, 2024

Changes in this version

+ var RouteErrorOption = &RouteErrorOpt

type BaseModelMeta

+ func BaseModelMetaFrom(obj any, index int, paramType RouteParamType) (*BaseModelMeta, error)

+ type RouteErrorOpt struct

+ Description string

+ ResponseMode *BaseModelMeta

+ StatusCode int

v0.2.8-pre

Apr 22, 2024

v0.2.7

Apr 19, 2024

v0.2.7-pre

Apr 19, 2024

v0.2.6

Apr 19, 2024

Changes in this version

+ const MIMEBmp

+ const MIMEGif

+ const MIMEJpeg

+ const MIMEJpg

+ const MIMEPdf

+ const MIMEPng

+ const MIMEPpt

+ const MIMESvg

+ const MIMETiff

+ const MIMEWebp

+ const MIMEWord

+ const MIMEXls

+ const MIMEZip

v0.2.5

Mar 24, 2024

v0.2.4

Mar 22, 2024

Changes in this version

+ const CookiesParamType

+ const HeadersParamType

+ const PathParamType

v0.2.3

Mar 20, 2024

v0.2.2

Jan 25, 2024

v0.2.1

Jan 24, 2024

v0.2.0

Jan 19, 2024

Changes in this version

+ const ArrayTypeSuffix

+ const CustomQueryNameConnector

+ const DateParamSchemaFormat

+ const DateTimeParamSchemaFormat

+ const DocumentUrl

+ const FileParamSchemaFormat

+ const GenericTypeConnector

+ const Int16Maximum

+ const Int16Minimum

+ const Int32Maximum

+ const Int32Minimum

+ const Int64Maximum

+ const Int64Minimum

+ const Int8Maximum

+ const Int8Minimum

+ const IntMaximum

+ const IntMinimum

+ const ReDocumentUrl

+ const ReminderWhenResponseModelIsNil

+ const RouteMethodSeparator

+ const SchemaDescMethodName

+ const SchemaTypeMethodName

+ const TimeParamSchemaFormat

+ const TimePkg

+ const Uint16Maximum

+ const Uint16Minimum

+ const Uint32Maximum

+ const Uint32Minimum

+ const Uint64Maximum

+ const Uint64Minimum

+ const Uint8Maximum

+ const Uint8Minimum

+ const UintMaximum

+ const UintMinimum

+ var DefaultValueTagNam = "default"

+ var DescriptionTagName = "description"

+ var IllegalRouteParamType = []reflect.Kind

+ var InnerModelsName = []string

+ var InnerModelsPkg = []string

+ var JsonTagName = "json"

+ var ParamRequiredLabel = requiredTag

+ var QueryTagName = "query"

+ var ValidateTagName = "validate"

+ var ValidatorLabelToOpenapiLabel = map[string]string

+ func AssignGenericModelPkg(modelString string) string

+ func CreateRouteIdentify(method, url string) string

+ func IsGenericModel(name string) bool

+ func IsGenericModelByType(rt reflect.Type) bool

+ func ParseGenericModelName(name string) []string

+ func ReflectCallSchemaDesc(re reflect.Type) string

+ func ToFastApiRoutePath(path string) string

+ type BaseModelField struct

+ Anonymous bool

+ DataType DataType

+ Description string

+ Exported bool

+ ItemRef string

+ Name string

+ Pkg string

+ Tag reflect.StructTag

+ func (f *BaseModelField) Init() (err error)

+ func (f *BaseModelField) InnerSchema() []SchemaIface

+ func (f *BaseModelField) IsArray() bool

+ func (f *BaseModelField) IsRequired() bool

+ func (f *BaseModelField) JsonName() string

+ func (f *BaseModelField) Schema() (m map[string]any)

+ func (f *BaseModelField) SchemaDesc() string

+ func (f *BaseModelField) SchemaPkg() string

+ func (f *BaseModelField) SchemaTitle() string

+ func (f *BaseModelField) SchemaType() DataType

+ type BaseModelMeta struct

+ Description string

+ Param *RouteParam

+ func NewBaseModelMeta(param *RouteParam) *BaseModelMeta

+ func (m *BaseModelMeta) HasValidateTag() bool

+ func (m *BaseModelMeta) Init() (err error)

+ func (m *BaseModelMeta) InnerSchema() []SchemaIface

+ func (m *BaseModelMeta) IsRequired() bool

+ func (m *BaseModelMeta) JsonName() string

+ func (m *BaseModelMeta) Name() string

+ func (m *BaseModelMeta) Scan() (err error)

+ func (m *BaseModelMeta) ScanInner() (err error)

+ func (m *BaseModelMeta) Schema() (dict map[string]any)

+ func (m *BaseModelMeta) SchemaDesc() string

+ func (m *BaseModelMeta) SchemaPkg() string

+ func (m *BaseModelMeta) SchemaTitle() string

+ func (m *BaseModelMeta) SchemaType() DataType

type DataType

+ func ReflectKindToType(kind reflect.Kind) (name DataType)

+ func (m DataType) IsBaseType() bool

type HTTPValidationError

+ func (v *HTTPValidationError) InnerSchema() []SchemaIface

+ func (v *HTTPValidationError) JsonName() string

+ func (v *HTTPValidationError) SchemaPkg() string

+ func (v *HTTPValidationError) SchemaTitle() string

type ModelContentSchema

+ SchemaPkg func() string

+ SchemaTitle func() string

+ type ModelSchema interface

+ IsRequired func() bool

+ SchemaDesc func() string

+ SchemaType func() DataType

type OpenApi

+ func (o *OpenApi) AddContact(info Contact) *OpenApi

+ func (o *OpenApi) AddLicense(info License) *OpenApi

+ func (o *OpenApi) RegisterFrom(swagger *RouteSwagger) *OpenApi

type Operation

+ func (o *Operation) RequestBodyFrom(model *BaseModelMeta) *Operation

+ func (o *Operation) ResponseFrom(model *BaseModelMeta) *Operation

type Parameter

+ func (p *Parameter) FromQModel(model *QModel) *Parameter

type ParameterSchema

+ Format string

type QModel

+ DataType DataType

+ Desc string

+ InStruct bool

+ IsTime bool

+ JName string

+ Kind reflect.Kind

+ QName string

+ Required bool

+ func StructToQModels(rt reflect.Type) []*QModel

+ func (q *QModel) Init() (err error)

+ func (q *QModel) JsonName() string

+ func (q *QModel) SchemaPkg() string

+ func (q *QModel) SchemaTitle() string

+ type RouteParam struct

+ DataType DataType

+ Index int

+ IsGeneric bool

+ IsNil bool

+ IsPtr bool

+ IsTime bool

+ Name string

+ Pkg string

+ Prototype reflect.Type

+ PrototypeKind reflect.Kind

+ QueryName string

+ RouteParamType RouteParamType

+ T ModelSchema

+ func NewRouteParam(rt reflect.Type, index int, paramType RouteParamType) *RouteParam

+ func (r *RouteParam) CopyPrototype() reflect.Type

+ func (r *RouteParam) ElemKind() reflect.Kind

+ func (r *RouteParam) Init() (err error)

+ func (r *RouteParam) InnerSchema() []SchemaIface

+ func (r *RouteParam) IsRequired() bool

+ func (r *RouteParam) JsonName() string

+ func (r *RouteParam) NewNotStruct(value any) reflect.Value

+ func (r *RouteParam) Rename(pkg, name string)

+ func (r *RouteParam) Scan() (err error)

+ func (r *RouteParam) ScanInner() (err error)

+ func (r *RouteParam) Schema() (m map[string]any)

+ func (r *RouteParam) SchemaDesc() string

+ func (r *RouteParam) SchemaPkg() string

+ func (r *RouteParam) SchemaTitle() string

+ func (r *RouteParam) SchemaType() DataType

+ type RouteParamType string

+ const RouteParamPath

+ const RouteParamQuery

+ const RouteParamRequest

+ const RouteParamResponse

+ type RouteSwagger struct

+ Api string

+ Deprecated bool

+ Description string

+ Method string

+ PathFields []*QModel

+ QueryFields []*QModel

+ RelativePath string

+ RequestContentType string

+ RequestModel *BaseModelMeta

+ ResponseContentType string

+ ResponseModel *BaseModelMeta

+ Summary string

+ Tags []string

+ UploadFile SchemaIface

+ Url string

+ func (r *RouteSwagger) Id() string

+ func (r *RouteSwagger) Init() (err error)

+ func (r *RouteSwagger) Scan() (err error)

+ func (r *RouteSwagger) ScanInner() (err error)

type SchemaIface

+ InnerSchema func() []SchemaIface

+ JsonName func() string

+ SchemaPkg func() string

+ SchemaTitle func() string

+ type UploadFileMeta struct

+ func (f *UploadFileMeta) ContentType() string

+ func (f *UploadFileMeta) InnerSchema() []SchemaIface

+ func (f *UploadFileMeta) IsRequired() bool

+ func (f *UploadFileMeta) JsonName() string

+ func (f *UploadFileMeta) Schema() (m map[string]any)

+ func (f *UploadFileMeta) SchemaDesc() string

+ func (f *UploadFileMeta) SchemaPkg() string

+ func (f *UploadFileMeta) SchemaTitle() string

+ func (f *UploadFileMeta) SchemaType() DataType

type ValidationError

+ func (v *ValidationError) InnerSchema() []SchemaIface

+ func (v *ValidationError) JsonName() string

+ func (v *ValidationError) SchemaPkg() string

+ func (v *ValidationError) SchemaTitle() string

v0.2.0-pre1

Jan 10, 2024

v0.2.0-beta3

Dec 24, 2023

v0.2.0-beta2

Dec 23, 2023

v0.2.0-beta

Dec 19, 2023

v0.1.7

Oct 18, 2023

v0.1.6

Sep 14, 2023

v0.1.5

Sep 11, 2023

Changes in this version

+ const AnonymousModelNameConnector

+ const ArrayTypePrefix

+ const HttpValidationErrorName

+ const InnerModelNamePrefix

+ const RefName

+ const RefPrefix

+ const ValidationErrorName

+ var Bool = makeMetadata("Bool", "布尔类型", `json:"boolean" oneof:"true false"`, BoolType)

+ var Float = makeMetadata("Float", "64位的浮点类型", `json:"float"`, NumberType)

+ var Float32 = makeMetadata("Float32", "32位的浮点类型", `json:"float32"`, NumberType)

+ var Float64 = makeMetadata("Float64", "64位的浮点类型", `json:"float64"`, NumberType)

+ var Int = makeMetadata("Int", "有符号的数字类型", ...)

+ var Int16 = makeMetadata("Int16", "16位有符号的数字类型", ...)

+ var Int32 = makeMetadata("Int32", "32位有符号的数字类型", ...)

+ var Int64 = makeMetadata("Int64", "64位有符号的数字类型", ...)

+ var Int8 = makeMetadata("Int8", "8位有符号的数字类型", `json:"int8" gte:"-128" lte:"127"`, ...)

+ var String = makeMetadata("String", "字符串类型", `json:"string" min:"0" max:"255"`, StringType)

+ var Uint16 = makeMetadata("Uint16", "16位无符号的数字类型", `json:"uint16" gte:"0" lte:"65535"`, ...)

+ var Uint32 = makeMetadata("Uint32", "32位无符号的数字类型", ...)

+ var Uint64 = makeMetadata("Uint64", "64位无符号的数字类型", ...)

+ var Uint8 = makeMetadata("Uint8", "8位无符号的数字类型", `json:"uint8" gte:"0" lte:"255"`, ...)

+ var ValidationErrorDefinition = &ValidationError

+ var ValidationErrorResponseDefinition = &HTTPValidationError

+ func GetDefaultV(tag reflect.StructTag, otype DataType) (v any)

+ func IsArray(object any) bool

+ func IsFieldRequired(tag reflect.StructTag) bool

+ func QueryFieldTag(tag reflect.StructTag, label string, undefined string) string

+ func QueryJsonName(tag reflect.StructTag, undefined string) string

+ func ReflectObjectType(obj any) reflect.Type

+ func StringsToFloats(strs []string) []float64

+ func StringsToInts(strs []string) []int

+ type ArgsType struct

+ func (m ArgsType) FieldType() reflect.Type

+ func (m ArgsType) IsAnonymousStruct() bool

+ func (m ArgsType) String() string

+ type BaseModel struct

+ func (b *BaseModel) ID() string

+ func (b *BaseModel) IsRequired() bool

+ func (b *BaseModel) Metadata() (*Metadata, error)

+ func (b *BaseModel) Schema() (m map[string]any)

+ func (b *BaseModel) SchemaDesc() string

+ func (b *BaseModel) SchemaName(exclude ...bool) string

+ func (b *BaseModel) SchemaType() DataType

+ type DataType string

+ const ArrayType

+ const BoolType

+ const IntegerType

+ const NumberType

+ const ObjectType

+ const StringType

+ func ReflectKindToOType(kind reflect.Kind) (name DataType)

+ type Field struct

+ Description string

+ ItemRef string

+ Tag reflect.StructTag

+ Title string

+ Type DataType

+ func (f *Field) InnerSchema() (m map[string]map[string]any)

+ func (f *Field) IsArray() bool

+ func (f *Field) IsRequired() bool

+ func (f *Field) Metadata() (*Metadata, error)

+ func (f *Field) Schema() (m map[string]any)

+ func (f *Field) SchemaDesc() string

+ func (f *Field) SchemaName(exclude ...bool) string

+ func (f *Field) SchemaType() DataType

+ func (f *Field) SetId(id string)

+ type HTTPValidationError struct

+ Detail []*ValidationError

+ func (v *HTTPValidationError) Error() string

+ func (v *HTTPValidationError) Schema() map[string]any

+ func (v *HTTPValidationError) SchemaDesc() string

+ func (v *HTTPValidationError) SchemaName(exclude ...bool) string

+ func (v *HTTPValidationError) SchemaType() DataType

+ func (v *HTTPValidationError) String() string

+ type MetaCache struct

+ func (m *MetaCache) Get(pkg string) *Metadata

+ func (m *MetaCache) Set(meta *Metadata)

+ type MetaField struct

+ Anonymous bool

+ Exported bool

+ func (m *MetaField) ToMetadata() (bool, *Metadata)

+ type Metadata struct

+ func BaseModelToMetadata(model SchemaIface) *Metadata

+ func GetMetadata(pkg string) *Metadata

+ func List(model SchemaIface) *Metadata

+ func (m *Metadata) AddField(field *MetaField, depth int)

+ func (m *Metadata) Fields() []*MetaField

+ func (m *Metadata) FromModel(model SchemaIface)

+ func (m *Metadata) FromReflectType(rt reflect.Type)

+ func (m *Metadata) Id() string

+ func (m *Metadata) InnerFields() []*MetaField

+ func (m *Metadata) IsRequired() bool

+ func (m *Metadata) Metadata() (*Metadata, error)

+ func (m *Metadata) Name() string

+ func (m *Metadata) ReflectType() reflect.Type

+ func (m *Metadata) Schema() map[string]any

+ func (m *Metadata) SchemaDesc() string

+ func (m *Metadata) SchemaName(exclude ...bool) string

+ func (m *Metadata) SchemaType() DataType

+ func (m *Metadata) String() string

+ type QModel struct

+ InPath bool

+ Name string

+ Tag reflect.StructTag

+ Title string

+ Type DataType

+ func ParseToQueryModels(q QueryParameter) []*QModel

+ func (q *QModel) InnerSchema() (m map[string]map[string]any)

+ func (q *QModel) IsRequired() bool

+ func (q *QModel) Metadata() (*Metadata, error)

+ func (q *QModel) Schema() (m map[string]any)

+ func (q *QModel) SchemaDesc() string

+ func (q *QModel) SchemaName(exclude ...bool) string

+ func (q *QModel) SchemaType() DataType

+ func (q *QModel) SetId(id string)

+ type QueryModel struct

+ func (q *QueryModel) Fields() []*QModel

+ type QueryParameter interface

+ type SchemaIface interface

+ IsRequired func() bool

+ Metadata func() (*Metadata, error)

+ Schema func() (m map[string]any)

+ SchemaDesc func() string

+ SchemaName func(exclude ...bool) string

+ SchemaType func() DataType

+ type ValidationError struct

+ Ctx map[string]any

+ Loc []string

+ Msg string

+ Type string

+ func (v *ValidationError) Error() string

+ func (v *ValidationError) Schema() (m map[string]any)

+ func (v *ValidationError) SchemaDesc() string

+ func (v *ValidationError) SchemaName(exclude ...bool) string

+ func (v *ValidationError) SchemaType() DataType

v0.1.4

Sep 5, 2023

v0.1.3

Jul 26, 2023

v0.1.1

May 22, 2023

v0.1.0

Mar 29, 2023

Changes in this version

+ const ApiVersion

+ const FaviconIcoName

+ const FaviconName

+ const HeaderContentType

+ const JsonUrl

+ const MIMEApplicationForm

+ const MIMEApplicationJSON

+ const MIMEApplicationJSONCharsetUTF8

+ const MIMEApplicationXML

+ const MIMEApplicationXMLCharsetUTF8

+ const MIMEMultipartForm

+ const MIMEOctetStream

+ const MIMETextCSS

+ const MIMETextCSSCharsetUTF8

+ const MIMETextHTML

+ const MIMETextHTMLCharsetUTF8

+ const MIMETextJavaScript

+ const MIMETextJavaScriptCharsetUTF8

+ const MIMETextPlain

+ const MIMETextPlainCharsetUTF8

+ const MIMETextXML

+ const MIMETextXMLCharsetUTF8

+ const OptionalPathParamSuffix

+ const PathParamPrefix

+ const PathSeparator

+ const RedocJsName

+ const RedocJsUrl

+ const SwaggerCssName

+ const SwaggerCssUrl

+ const SwaggerFaviconUrl

+ const SwaggerJsName

+ const SwaggerJsUrl

+ var Resp422 = &Response

+ func Asset(name string) ([]byte, error)

+ func AssetDir(name string) ([]string, error)

+ func AssetInfo(name string) (os.FileInfo, error)

+ func AssetNames() []string

+ func FastApiRoutePath(path string) string

+ func MakeOauth2RedirectHtml() string

+ func MakeRedocUiHtml(title, openapiUrl, jsUrl, faviconUrl string) string

+ func MakeSwaggerUiHtml(title, openapiUrl, jsUrl, cssUrl, faviconUrl string) string

+ func MustAsset(name string) []byte

+ func RestoreAsset(dir, name string) error

+ func RestoreAssets(dir, name string) error

+ type APIKeyIn string

+ const APIKeyInCookie

+ const APIKeyInHeader

+ const APIKeyInQuery

+ type ComponentScheme struct

+ Model *godantic.Metadata

+ Name string

+ type Components struct

+ Scheme []*ComponentScheme

+ func (c *Components) AddModel(m *godantic.Metadata)

+ func (c *Components) MarshalJSON() ([]byte, error)

+ type Contact struct

+ Email string

+ Name string

+ Url string

+ type Encoding struct

+ AllowReserved bool

+ ContentType string

+ Explode bool

+ Headers []Header

+ Style string

+ type Header struct

+ Content map[string]MediaType

+ Deprecated bool

+ Description string

+ Required bool

+ type Info struct

+ Contact Contact

+ Description string

+ License License

+ TermsOfService string

+ Title string

+ Version string

+ type License struct

+ Name string

+ Url string

+ type Link struct

+ Description string

+ OperationId string

+ OperationRef string

+ Parameters map[string]any

+ RequestBody RequestBody

+ Server Server

+ func (l Link) Alias() string

+ type MediaType struct

+ Encoding map[string]Encoding

+ type ModelContentSchema interface

+ Schema func() map[string]any

+ SchemaName func(exclude ...bool) string

+ SchemaType func() godantic.OpenApiDataType

+ type OpenApi struct

+ Components *Components

+ Info *Info

+ Paths *Paths

+ Version string

+ func NewOpenApi(title, version, description string) *OpenApi

+ func (o *OpenApi) AddDefinition(meta *godantic.Metadata) *OpenApi

+ func (o *OpenApi) QueryPathItem(path string) *PathItem

+ func (o *OpenApi) RecreateDocs() *OpenApi

+ func (o *OpenApi) Schema() []byte

+ type Operation struct

+ Deprecated bool

+ Description string

+ OperationId string

+ Parameters []*Parameter

+ RequestBody *RequestBody

+ Responses []*Response

+ Summary string

+ Tags []string

+ func (o *Operation) MarshalJSON() ([]byte, error)

+ type Parameter struct

+ Default any

+ Schema *ParameterSchema

+ func QModelToParameter(model *godantic.QModel) *Parameter

+ type ParameterBase struct

+ Deprecated bool

+ Description string

+ In ParameterInType

+ Name string

+ Required bool

+ type ParameterInType string

+ const InCookie

+ const InHeader

+ const InPath

+ const InQuery

+ type ParameterSchema struct

+ Title string

+ Type godantic.OpenApiDataType

+ type PathItem struct

+ Delete *Operation

+ Get *Operation

+ Head *Operation

+ Patch *Operation

+ Path string

+ Post *Operation

+ Put *Operation

+ Trace *Operation

+ type PathModelContent struct

+ MIMEType string

+ Schema ModelContentSchema

+ func (p *PathModelContent) MarshalJSON() ([]byte, error)

+ type Paths struct

+ Paths []*PathItem

+ func (p *Paths) AddItem(item *PathItem)

+ func (p *Paths) MarshalJSON() ([]byte, error)

+ type Reference struct

+ Name string

+ func (r *Reference) MarshalJSON() ([]byte, error)

+ type RequestBody struct

+ Content *PathModelContent

+ Required bool

+ func MakeOperationRequestBody(model *godantic.Metadata) *RequestBody

+ type Response struct

+ Content *PathModelContent

+ Description string

+ StatusCode int

+ func MakeOperationResponses(model *godantic.Metadata) []*Response

+ type Server struct

+ Description string

+ Url string

+ Variables []ServerVariable

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ type Tag struct

+ Description string

+ Name string

+ func (t Tag) Schema() map[string]string

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