unalcohol

Documentation

Index

• func DefaultStatusBadRequest(r *http.Request, w http.ResponseWriter) error
• func DefaultStatusInternalServerError(r *http.Request, w http.ResponseWriter) error
• func DefaultStatusMethodNotAllowed(r *http.Request, w http.ResponseWriter) error
• func JoinPath(ptr API, url string) string
• type API
• type BaseAPI
  • func (a *BaseAPI) GetPath() string
  • func (a *BaseAPI) GetPtr() API
  • func (a *BaseAPI) Middleware(r *http.Request, resp http.ResponseWriter) error
• type Body
  • func (b *Body[T]) Doc(key string, operation *openapi3.Operation) error
  • func (b *Body[T]) ParseRequest(key string, r *http.Request, resp http.ResponseWriter) (err error)
• type Header
  • func (p *Header[T]) Doc(key string, operation *openapi3.Operation) error
  • func (h *Header[T]) ParseRequest(key string, r *http.Request, resp http.ResponseWriter) (err error)
• type IOResponse
  • func (r *IOResponse) Doc(operation *openapi3.Operation) error
  • func (r *IOResponse) WriteResponse(w http.ResponseWriter) error
• type JSON
  • func (j *JSON[T]) Doc(key string, operation *openapi3.Operation) error
  • func (j *JSON[T]) ParseRequest(key string, r *http.Request, resp http.ResponseWriter) (err error)
• type JSONResponse
  • func (r *JSONResponse[T]) Doc(operation *openapi3.Operation) error
  • func (r *JSONResponse[T]) WriteResponse(w http.ResponseWriter) error
• type Middleware
• type Param
  • func (p *Param[T]) Doc(key string, operation *openapi3.Operation) error
  • func (p *Param[T]) ParseRequest(key string, r *http.Request, resp http.ResponseWriter) (err error)
• type Path
  • func (p *Path[T]) Doc(key string, operation *openapi3.Operation) error
  • func (p *Path[T]) ParseRequest(key string, r *http.Request, resp http.ResponseWriter) (err error)
• type Request
  • func (r *Request) Doc(key string, operation *openapi3.Operation) error
  • func (r *Request) ParseRequest(key string, req *http.Request, resp http.ResponseWriter) (err error)
• type Response
  • func (r *Response) Doc(key string, operation *openapi3.Operation) error
  • func (r *Response) ParseRequest(key string, req *http.Request, resp http.ResponseWriter) (err error)
• type ResponseInf
• type Server
  • func New(address string) *Server
  • func (srv *Server) GetMux() *http.ServeMux
  • func (srv *Server) Middleware(r *http.Request, resp http.ResponseWriter) error
  • func (srv *Server) Start() error

Functions

func DefaultStatusBadRequest

func DefaultStatusBadRequest(r *http.Request, w http.ResponseWriter) error

func DefaultStatusInternalServerError

func DefaultStatusInternalServerError(r *http.Request, w http.ResponseWriter) error

func DefaultStatusMethodNotAllowed

func DefaultStatusMethodNotAllowed(r *http.Request, w http.ResponseWriter) error

func JoinPath

func JoinPath(ptr API, url string) string

Types

type API

type API interface {
	GetPath() string
	GetPtr() API
}

type BaseAPI

type BaseAPI struct {
	Path string
	Tags []string
}

func (*BaseAPI) GetPath

func (a *BaseAPI) GetPath() string

func (*BaseAPI) GetPtr

func (a *BaseAPI) GetPtr() API

func (*BaseAPI) Middleware

func (a *BaseAPI) Middleware(r *http.Request, resp http.ResponseWriter) error

type Body

type Body[T any] struct {
	Value T
}

func (*Body[T]) Doc

func (b *Body[T]) Doc(key string, operation *openapi3.Operation) error

func (*Body[T]) ParseRequest

func (b *Body[T]) ParseRequest(key string, r *http.Request, resp http.ResponseWriter) (err error)

type Header

type Header[T any] struct {
	Value T
}

func (*Header[T]) Doc

func (p *Header[T]) Doc(key string, operation *openapi3.Operation) error

func (*Header[T]) ParseRequest

func (h *Header[T]) ParseRequest(key string, r *http.Request, resp http.ResponseWriter) (err error)

type IOResponse

type IOResponse struct {
	Code int
	Data io.ReadCloser
}

func (*IOResponse) Doc

func (r *IOResponse) Doc(operation *openapi3.Operation) error

func (*IOResponse) WriteResponse

func (r *IOResponse) WriteResponse(w http.ResponseWriter) error

type JSON

type JSON[T any] struct {
	Value T
}

func (*JSON[T]) Doc

func (j *JSON[T]) Doc(key string, operation *openapi3.Operation) error

func (*JSON[T]) ParseRequest

func (j *JSON[T]) ParseRequest(key string, r *http.Request, resp http.ResponseWriter) (err error)

type JSONResponse

type JSONResponse[T any] struct {
	Code int
	Data T
}

func (*JSONResponse[T]) Doc

func (r *JSONResponse[T]) Doc(operation *openapi3.Operation) error

func (*JSONResponse[T]) WriteResponse

func (r *JSONResponse[T]) WriteResponse(w http.ResponseWriter) error

type Middleware

type Middleware = func(*http.Request, http.ResponseWriter) error

type Param

type Param[T any] struct {
	Value T
}

func (*Param[T]) Doc

func (p *Param[T]) Doc(key string, operation *openapi3.Operation) error

func (*Param[T]) ParseRequest

func (p *Param[T]) ParseRequest(key string, r *http.Request, resp http.ResponseWriter) (err error)

type Path

type Path[T int | string | float32 | float64 | int64] struct {
	Value T
}

func (*Path[T]) Doc

func (p *Path[T]) Doc(key string, operation *openapi3.Operation) error

func (*Path[T]) ParseRequest

func (p *Path[T]) ParseRequest(key string, r *http.Request, resp http.ResponseWriter) (err error)

type Request

type Request struct {
	Value *http.Request
}

func (*Request) Doc

func (r *Request) Doc(key string, operation *openapi3.Operation) error

func (*Request) ParseRequest

func (r *Request) ParseRequest(key string, req *http.Request, resp http.ResponseWriter) (err error)

type Response

type Response struct {
	Value http.ResponseWriter
}

func (*Response) Doc

func (r *Response) Doc(key string, operation *openapi3.Operation) error

func (*Response) ParseRequest

func (r *Response) ParseRequest(key string, req *http.Request, resp http.ResponseWriter) (err error)

type ResponseInf

type ResponseInf interface {
	WriteResponse(http.ResponseWriter) error
}

type Server

type Server struct {
	Mux  *http.ServeMux
	Addr string

	StatusBadRequest          Middleware
	StatusMethodNotAllowed    Middleware
	StatusInternalServerError Middleware
	// contains filtered or unexported fields
}

func New

func New(address string) *Server

func (*Server) GetMux

func (srv *Server) GetMux() *http.ServeMux

func (*Server) Middleware

func (srv *Server) Middleware(r *http.Request, resp http.ResponseWriter) error

func (*Server) Start

func (srv *Server) Start() error