Documentation
¶
Index ¶
- func GetTypeName(v any) string
- func ToPointer[T any](v T) *T
- type EndpointDoc
- type HandlerProvider
- type OperationBuilder
- func (ob *OperationBuilder) Build() *openapi3.Operation
- func (ob *OperationBuilder) WithDescription(desc string) *OperationBuilder
- func (ob *OperationBuilder) WithParameter(name, in, description string, required bool, schemaType any) *OperationBuilder
- func (ob *OperationBuilder) WithParameterRef(ref string) *OperationBuilder
- func (ob *OperationBuilder) WithRequestBodyType(bodyType any, description string, required bool) *OperationBuilder
- func (ob *OperationBuilder) WithResponse(statusCode int, description string, responseType any) *OperationBuilder
- func (ob *OperationBuilder) WithTags(tags ...string) *OperationBuilder
- type Path
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetTypeName ¶
Types ¶
type EndpointDoc ¶
type EndpointDoc struct {
Path string
Version int
Method string
PathItem *OperationBuilder
}
func (*EndpointDoc) BuildOpenAPiStruct ¶
func (ep *EndpointDoc) BuildOpenAPiStruct() Path
func (*EndpointDoc) GetPath ¶
func (ep *EndpointDoc) GetPath() string
type HandlerProvider ¶
type HandlerProvider interface{}
type OperationBuilder ¶
type OperationBuilder struct {
// contains filtered or unexported fields
}
func NewOperationBuilder ¶
func NewOperationBuilder() *OperationBuilder
func (*OperationBuilder) Build ¶
func (ob *OperationBuilder) Build() *openapi3.Operation
func (*OperationBuilder) WithDescription ¶
func (ob *OperationBuilder) WithDescription(desc string) *OperationBuilder
func (*OperationBuilder) WithParameter ¶
func (ob *OperationBuilder) WithParameter(name, in, description string, required bool, schemaType any) *OperationBuilder
func (*OperationBuilder) WithParameterRef ¶
func (ob *OperationBuilder) WithParameterRef(ref string) *OperationBuilder
func (*OperationBuilder) WithRequestBodyType ¶
func (ob *OperationBuilder) WithRequestBodyType(bodyType any, description string, required bool) *OperationBuilder
func (*OperationBuilder) WithResponse ¶
func (ob *OperationBuilder) WithResponse(statusCode int, description string, responseType any) *OperationBuilder
func (*OperationBuilder) WithTags ¶
func (ob *OperationBuilder) WithTags(tags ...string) *OperationBuilder
Click to show internal directories.
Click to hide internal directories.