openapi

package module

Go to main page

Versions in this module

v0

v0.2.0

Feb 5, 2024

Changes in this version

+ func CleanPath(path string) string

type Code

+ const DefaultStatus

+ func (c *Code) UnmarshalText(b []byte) error

+ func (c Code) MarshalText() ([]byte, error)

type Media

+ func (m *Media) AddExample(exName string, i any)

type OpenAPI

+ Components Components

+ func (o *OpenAPI) Compile() error

+ func (o *OpenAPI) GetRoute(path, method string) *Route

+ func (o *OpenAPI) JSONBytes() []byte

+ type ParamSetter func() Param

type Params

+ func (p *Params) UnmarshalJSON(b []byte) error

+ func (p Params) List() []Param

+ func (p Params) MarshalJSON() ([]byte, error)

type RequestBody

+ func (r RequestBody) WithExample(i any) RequestBody

+ func (r RequestBody) WithJSONString(s string) RequestBody

+ func (r RequestBody) WithNamedExample(name string, i any) RequestBody

type Response

+ Status Code

+ func (r Response) WithExample(i any) Response

+ func (r Response) WithJSONString(s string) Response

+ func (r Response) WithNamedExample(name string, i any) Response

type Route

+ Summary string

+ func (r *Route) AddParam(pType, name string, value any, desc string) *Route

+ func (r *Route) AddRequest(req RequestBody) *Route

+ func (r *Route) AddResponse(resp Response) *Route

+ func (r *Route) CookieParam(name string, value any, desc string) *Route

+ func (r *Route) CookieParams(value any) *Route

+ func (r *Route) HeaderParam(name string, value any, desc string) *Route

+ func (r *Route) HeaderParams(value any) *Route

+ func (r *Route) PathParam(name string, value any, desc string) *Route

+ func (r *Route) PathParams(value any) *Route

+ func (r *Route) QueryParam(name string, value any, desc string) *Route

+ func (r *Route) QueryParams(value any) *Route

+ func (r *Route) Tags(tag ...string) *Route

+ type Router map[string]*Route

+ func (r Router) MarshalJSON() ([]byte, error)

+ func (r Router) UnmarshalJSON(b []byte) error

type Schema

+ Ref string

v0.1.13

Mar 24, 2023

Changes in this version

type Param

+ Examples map[string]Example

type RouteParam

+ Examples []ExampleObject

v0.1.12

Feb 6, 2023

Changes in this version

type ExampleObject

+ Desc string

+ Name string

v0.1.11

Feb 6, 2023

v0.1.10

Feb 2, 2023

v0.1.9

Feb 2, 2023

Changes in this version

type BodyObject

+ Examples []ExampleObject

+ type Encoding struct

+ ContentType string

+ Style string

+ type Example struct

+ Desc string

+ ExternalValue string

+ Summary string

+ Value any

+ type ExampleObject struct

+ Example any

+ Summary string

type Media

+ Encoding map[string]Encoding

+ Example any

+ Examples map[string]Example

v0.1.8

Jan 30, 2023

Changes in this version

type Schema

+ ExternalDocs *ExternalDocs

+ type Time struct

+ Format string

+ func (t *Time) UnmarshalJSON(data []byte) error

+ func (t *Time) UnmarshalText(data []byte) error

+ func (t Time) MarshalJSON() (data []byte, err error)

+ func (t Time) MarshalText() ([]byte, error)

+ type TypeInfo struct

+ Format string

+ Simple bool

+ Type string

v0.1.7

Jan 11, 2023

Changes in this version

type BodyObject

+ func NewReqBody(mtype MIMEType, desc string, example any) BodyObject

+ func NewRespBody(mtype MIMEType, status Code, desc string, example any) BodyObject

v0.1.6

Jan 11, 2023

Changes in this version

+ type Code string

+ type Content map[MIMEType]Media

type OpenAPI

+ func (o *OpenAPI) AddResponse(ur UniqueRoute, bo BodyObject) error

v0.1.5

Jan 9, 2023

v0.1.4

Nov 23, 2022

v0.1.3

Nov 23, 2022

Changes in this version

type OpenAPI

+ func (o *OpenAPI) AddRequest(ur UniqueRoute, bo BodyObject) error

+ func (o *OpenAPI) PathMethod(path string, method Method) (om OperationMap, op Operation, err error)

v0.1.2

Nov 22, 2022

v0.1.1

Nov 22, 2022

Changes in this version

+ const Default

+ func JSONRemarshal(bytes []byte) ([]byte, error)

+ type BodyObject struct

+ Array bool

+ Desc string

+ Example any

+ HttpStatus string

+ MIMEType MIMEType

+ Title string

+ func NewBody(mtype MIMEType, status, desc string, array bool, body any) BodyObject

+ type Components struct

+ Params map[string]Param

+ RequestBodies map[string]RequestBody

+ Schemas Schemas

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ type ExternalDocs struct

+ Desc string

+ URL string

+ type Format int

+ const Binary

+ const Byte

+ const Date

+ const DateTime

+ const Double

+ const Float

+ const Int32

+ const Int64

+ const Password

+ func (f Format) String() string

+ type Info struct

+ Contact *Contact

+ Desc string

+ License *License

+ Terms string

+ Title string

+ Version string

+ type License struct

+ Name string

+ URL string

+ type MIMEType string

+ const Form

+ const General

+ const Html

+ const Jscript

+ const Json

+ const Text

+ const XForm

+ const Xml

+ type Media struct

+ Schema Schema

+ type Method string

+ const DELETE

+ const GET

+ const HEAD

+ const OPTIONS

+ const PATCH

+ const POST

+ const PUT

+ const TRACE

+ type OpenAPI struct

+ ExternalDocs *ExternalDocs

+ Info Info

+ Paths Paths

+ Routes map[UniqueRoute]Route

+ Servers []Server

+ Tags []Tag

+ Version string

+ func New(title, version, description string) *OpenAPI

+ func NewFromJson(spec string) (api *OpenAPI, err error)

+ func (o *OpenAPI) AddParam(ur UniqueRoute, rp RouteParam) error

+ func (o *OpenAPI) AddResp(ur UniqueRoute, bo BodyObject) error

+ func (o *OpenAPI) AddRoute(path, method, tag, desc, summary string) (ur UniqueRoute, err error)

+ func (o *OpenAPI) AddTag(tag, description string)

+ func (o *OpenAPI) AddTags(t Tags)

+ func (o *OpenAPI) JSON() []byte

+ type Operation struct

+ Desc string

+ ExternalDocs *ExternalDocs

+ OperationID string

+ Params []Param

+ RequestBody *RequestBody

+ Responses Responses

+ Summary string

+ Tags []string

+ type OperationMap map[Method]Operation

+ type Param struct

+ Desc string

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ Style string

+ type Params map[string]Param

+ type Paths map[string]OperationMap

+ type Properties map[string]Schema

+ type Ref struct

+ Ref string

+ type Reference string

+ type RequestBody struct

+ Content map[MIMEType]Media

+ Desc string

+ Required *bool

+ type Requests map[string]RequestBody

+ type Response struct

+ Content map[string]Media

+ Desc string

+ type Responses map[string]Response

+ type Route struct

+ Content MIMEType

+ Desc string

+ Params map[string]RouteParam

+ ReqType Type

+ Requests map[string]RouteReq

+ RespType Type

+ Responses map[string]RouteResp

+ Tag string

+ type RouteParam struct

+ ArrayType Type

+ Desc string

+ Example map[string]any

+ Format Format

+ Location string

+ Name string

+ Required bool

+ Type Type

+ type RouteReq struct

+ Array bool

+ Content MIMEType

+ Ref Reference

+ type RouteResp struct

+ Array bool

+ Code string

+ Content MIMEType

+ Ref Reference

+ type Schema struct

+ AddProperties *Schema

+ Desc string

+ Example any

+ Format string

+ Items *Schema

+ Properties Properties

+ Title string

+ Type string

+ func BuildSchema(title, desc string, example bool, body any) (s Schema, err error)

+ type Schemas map[string]Schema

+ type Server struct

+ Desc string

+ URL string

+ Vars map[string]ServerVar

+ type ServerVar struct

+ Default string

+ Desc string

+ Enum []string

+ type Tag struct

+ Desc string

+ ExternalDocs *ExternalDocs

+ Name string

+ type Tags []Tag

+ type Type int

+ const Array

+ const Boolean

+ const Integer

+ const Number

+ const Object

+ const String

+ func (t Type) String() string

+ type UniqueRoute struct

+ Method Method

+ Path string

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