goapi

Oct 12, 2024

Changes in this version

type API

+ func (a *API) SetStructTagVariableMapping(m map[string]string)

Sep 26, 2024

Changes in this version

+ var SigningMethodES256 *SigningMethodECDSA = jwt.SigningMethodES256

+ var SigningMethodES384 *SigningMethodECDSA = jwt.SigningMethodES384

+ var SigningMethodES512 *SigningMethodECDSA = jwt.SigningMethodES512

+ var SigningMethodEdDSA *SigningMethodEd25519 = jwt.SigningMethodEdDSA

+ var SigningMethodHS256 *SigningMethodHMAC = jwt.SigningMethodHS256

+ var SigningMethodHS384 *SigningMethodHMAC = jwt.SigningMethodHS384

+ var SigningMethodHS512 *SigningMethodHMAC = jwt.SigningMethodHS512

+ var SigningMethodRS256 *SigningMethodRSA = jwt.SigningMethodRS256

+ var SigningMethodRS384 *SigningMethodRSA = jwt.SigningMethodRS384

+ var SigningMethodRS512 *SigningMethodRSA = jwt.SigningMethodRS512

type API

+ func (a *API) IncludeChildAPI(child *ChildAPI)

+ type ChildAPI struct

+ OpenAPIInfo *openapi.Info

+ OpenAPIServers []*openapi.Server

+ OpenAPITags []*openapi.Tag

+ func NewChildAPI(prefix string, isDocs bool, docsPath string) *ChildAPI

+ func (c *ChildAPI) AddMiddleware(middlewares ...Middleware)

+ func (c *ChildAPI) IncludeGroup(group *APIGroup)

+ func (c *ChildAPI) IncludeRouter(router any, prefix string, isDocs bool, middlewares ...Middleware)

+ type HTTPBearerJWT interface

+ DecryptKey func() (any, error)

+ EncryptKey func() (any, error)

+ HTTPBearerJWT func(jwt *JWT)

+ SigningMethod func() SigningMethod

+ type JWT struct

+ Audience []string

+ ExpiresAt time.Time

+ Extensions map[string]any

+ ID string

+ IssuedAt time.Time

+ Issuer string

+ NotBefore time.Time

+ Subject string

+ func (j *JWT) Encrypt(bearerJWT HTTPBearerJWT) (string, error)

+ func (j *JWT) GetAudience() (jwt.ClaimStrings, error)

+ func (j *JWT) GetExpirationTime() (*jwt.NumericDate, error)

+ func (j *JWT) GetIssuedAt() (*jwt.NumericDate, error)

+ func (j *JWT) GetIssuer() (string, error)

+ func (j *JWT) GetNotBefore() (*jwt.NumericDate, error)

+ func (j *JWT) GetSubject() (string, error)

+ func (j *JWT) MarshalJSON() ([]byte, error)

type Lang

+ JwtTranslate func(msg string) string

+ type SigningMethod = jwt.SigningMethod

+ type SigningMethodECDSA = jwt.SigningMethodECDSA

+ type SigningMethodEd25519 = jwt.SigningMethodEd25519

+ type SigningMethodHMAC = jwt.SigningMethodHMAC

+ type SigningMethodRSA = jwt.SigningMethodRSA

Sep 6, 2024

Changes in this version

type API

+ Swagger swagger.Config

Aug 19, 2024

Changes in this version

type Context

+ func (c *Context) ClientIP() string

+ func (c *Context) RemoteIP() string

Aug 16, 2024

Changes in this version

type Context

+ func (c *Context) FullPath() string

Aug 2, 2024

Changes in this version

type API

+ func (a *API) Handler() http.Handler

+ func (a *API) RunTLS(addr, certFile, keyFile string) (err error)

Jul 29, 2024

Changes in this version

+ type FileResponse struct

+ Body []byte

+ Filename string

+ func (h *FileResponse) GetBody() any

+ func (h *FileResponse) GetContentType() string

+ func (h *FileResponse) SetContentType(contentType string)

+ func (h *FileResponse) Write(w http.ResponseWriter)

type HTTPResponse

+ func (h *HTTPResponse[T]) GetContentType() string

+ func (h *HTTPResponse[T]) SetContentType(contentType string)

+ func (h *HTTPResponse[T]) Write(w http.ResponseWriter)

type Response

+ GetContentType func() string

+ SetContentType func(contentType string)

+ Write func(w http.ResponseWriter)

+ type SSEResponse struct

+ SSEWriter func(s *SSEvent)

+ func (s *SSEResponse) GetBody() any

+ func (s *SSEResponse) GetContentType() string

+ func (s *SSEResponse) SetContentType(contentType string)

+ func (s *SSEResponse) Write(w http.ResponseWriter)

+ type SSEvent struct

+ func (s *SSEvent) Write(data SSEventData)

+ type SSEventData struct

+ Data string

+ Event string

+ Id string

+ Retry uint

Jul 23, 2024

Changes in this version

type API

+ func (a *API) Logger() Logger

Jul 22, 2024

Changes in this version

+ func SetLogger(log Logger)

type API

+ func (a *API) IncludeGroup(group *APIGroup)

+ type APIGroup struct

+ func NewGroup(prefix string, isDocs bool) *APIGroup

+ func (g *APIGroup) AddMiddleware(middlewares ...Middleware)

+ func (g *APIGroup) IncludeGroup(group *APIGroup)

+ func (g *APIGroup) IncludeRouter(router any, prefix string, isDocs bool, middlewares ...Middleware)

type Logger

+ func GetLogger() Logger

Jul 9, 2024

Changes in this version

type API

+ func (a *API) DebugPprof()

+ func (a *API) Static(path, root string)

Jul 3, 2024

Changes in this version

type Context

+ func (c *Context) Logger() Logger

type ResponseWriter

+ func (r *ResponseWriter) Flush()

+ func (r *ResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error)

Jun 27, 2024

Changes in this version

+ func SetLogLevel(level LogLevel)

type API

+ func (a *API) SetLogger(log Logger)

type APP

+ Handle func(handler func(ctx *Context))

type Context

+ Log Logger

+ func (c *Context) SetMiddleware(middlewares ...Middleware)

+ type LogLevel uint

+ const LogDebug

+ const LogError

+ const LogFail

+ const LogInfo

+ const LogWarning

+ type Logger interface

+ Debug func(format string, a ...any)

+ Error func(format string, a ...any)

+ Fatal func(format string, a ...any)

+ Info func(format string, a ...any)

+ Warning func(format string, a ...any)

+ type ResponseWriter struct

+ func (r *ResponseWriter) Header() http.Header

+ func (r *ResponseWriter) Status() int

+ func (r *ResponseWriter) Write(b []byte) (int, error)

+ func (r *ResponseWriter) WriteHeader(statusCode int)

Jun 25, 2024

Changes in this version

+ func HTTPException(httpCode int, detail string, headers ...map[string]string)

+ type API struct

+ OpenAPIInfo *openapi.Info

+ OpenAPIServers []*openapi.Server

+ OpenAPITags []*openapi.Tag

+ func GoAPI(app APP, isDocs bool, docsPath ...string) *API

+ func (a *API) AddMiddleware(middlewares ...Middleware)

+ func (a *API) HTTPExceptionHandler(f func(httpCode int, detail string) Response)

+ func (a *API) IncludeRouter(router any, prefix string, isDocs bool, middlewares ...Middleware)

+ func (a *API) Run(addr ...string) error

+ func (a *API) SetLang(lang Lang)

+ func (a *API) SetResponseMediaType(mediaTypes ...MediaType)

+ type APP interface

+ DELETE func(path string, callback func(req *http.Request, writer http.ResponseWriter))

+ GET func(path string, callback func(req *http.Request, writer http.ResponseWriter))

+ HEAD func(path string, callback func(req *http.Request, writer http.ResponseWriter))

+ Init func()

+ OPTIONS func(path string, callback func(req *http.Request, writer http.ResponseWriter))

+ PATCH func(path string, callback func(req *http.Request, writer http.ResponseWriter))

+ POST func(path string, callback func(req *http.Request, writer http.ResponseWriter))

+ PUT func(path string, callback func(req *http.Request, writer http.ResponseWriter))

+ Run func(addr ...string) error

+ TRACE func(path string, callback func(req *http.Request, writer http.ResponseWriter))

+ type ApiKey interface

+ ApiKey func()

+ type Context struct

+ Request *http.Request

+ Values map[string]any

+ Writer http.ResponseWriter

+ func (c *Context) Deadline() (deadline time.Time, ok bool)

+ func (c *Context) Done() <-chan struct{}

+ func (c *Context) Err() error

+ func (c *Context) Get(key string) (value any, ok bool)

+ func (c *Context) Next()

+ func (c *Context) Set(key string, value any)

+ func (c *Context) Value(key any) any

+ type HTTPBasic interface

+ HTTPBasic func(username, password string)

+ type HTTPBearer interface

+ HTTPBearer func(token string)

+ type HTTPResponse struct

+ Body T

+ Header map[string]string

+ HttpCode int

+ func (h *HTTPResponse[T]) Bytes() []byte

+ func (h *HTTPResponse[T]) GetBody() any

+ func (h *HTTPResponse[T]) GetHeaders() map[string]string

+ func (h *HTTPResponse[T]) GetHttpCode() int

+ type HandleFunc func(ctx *Context)

+ type Lang interface

+ Enum func(field string, val []any) string

+ Gt func(field string, val float64) string

+ Gte func(field string, val float64) string

+ Lt func(field string, val float64) string

+ Lte func(field string, val float64) string

+ Max func(field string, val uint64) string

+ Min func(field string, val uint64) string

+ MultipleOf func(field string, val float64) string

+ Regexp func(field string, val string) string

+ Required func(field string) string

+ Unique func(field string) string

+ type MediaType string

+ const JSON

+ const XML

+ type Middleware func(ctx *Context)

+ type Response interface

+ Bytes func() []byte

+ GetBody func() any

+ GetHeaders func() map[string]string

+ GetHttpCode func() int

+ type Router struct