oas3

package

v1.7.0 Latest Latest Go to latest Published: Apr 29, 2025 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/honeybbq/goctl-openapi

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ConvertPath(path string) string
func GetDoc(p *plugin.Plugin, errorType string) (*openapi3.T, error)
func GetMapValueType(typ string) (string, error)
func GetProperty(properties map[string]string, key string) string
func IsUint(format string) bool
func MergeRequired(rs ...[]string) []string
func ParseInteger(format string, s string) (float64, error)
func ParseNumber(format string, s string) (float64, error)
func ParseValue(typ string, format string, s string) (interface{}, error)
func ParseValueFromType(typ *openapi3.Types, format string, s string) (interface{}, error)
func TypePointer(t string) *openapi3.Types
func UnescapeValidateString(s string) string
type DefaultErrorResponse

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	TypeObject  = TypePointer(openapi3.TypeObject)
	TypeArray   = TypePointer(openapi3.TypeArray)
	TypeString  = TypePointer(openapi3.TypeString)
	TypeNumber  = TypePointer(openapi3.TypeNumber)
	TypeInteger = TypePointer(openapi3.TypeInteger)
	TypeBoolean = TypePointer(openapi3.TypeBoolean)
)

Common type constants for convenience

View Source

var DefaultErrorDesc = "Error response."

View Source

var DefaultResponseDesc = "Successful response."

View Source

var (
	ErrInvalidType = fmt.Errorf("invalid type")
)

Functions ¶

func ConvertPath ¶

func ConvertPath(path string) string

func GetDoc ¶

func GetDoc(p *plugin.Plugin, errorType string) (*openapi3.T, error)

func GetMapValueType ¶

func GetMapValueType(typ string) (string, error)

GetMapValueType map[[2]string][]string -> []string

func GetProperty ¶

func GetProperty(properties map[string]string, key string) string

func IsUint ¶

func IsUint(format string) bool

func MergeRequired ¶

func MergeRequired(rs ...[]string) []string

MergeRequired merge schema required fields

func ParseInteger ¶

func ParseInteger(format string, s string) (float64, error)

func ParseNumber ¶

func ParseNumber(format string, s string) (float64, error)

func ParseValue ¶

func ParseValue(typ string, format string, s string) (interface{}, error)

func ParseValueFromType ¶

func ParseValueFromType(typ *openapi3.Types, format string, s string) (interface{}, error)

ParseValueFromType parses value based on schema type pointer

func TypePointer ¶

func TypePointer(t string) *openapi3.Types

TypePointer 辅助函数，将类型转换为 *openapi3.Types

func UnescapeValidateString ¶

func UnescapeValidateString(s string) string

https://pkg.go.dev/github.com/go-playground/validator/v10#hdr-Using_Validator_Tags

Types ¶

type DefaultErrorResponse ¶

type DefaultErrorResponse struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

Define a default error response structure

Source Files ¶

View all Source files

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