api

package module

Go to main page

Versions in this module

v0

v0.2.1

May 2, 2026

Changes in this version

+ var CurrentRequestMode = RequestModePlain

+ var CurrentResponseMode = ResponseModeEnvelope

+ var LogRequestBody bool = false

+ var LogResponseBody bool = false

+ var MaxLoggedBodyBytes int = 2000

+ var SensitiveLogKeys = []string

+ func LogResponseWithDuration(eventID string, res *httptest.ResponseRecorder, duration time.Duration)

+ func SetRequestMode(mode RequestMode)

+ func SetResponseMode(mode ResponseMode)

+ type RequestMode string

+ const RequestModeAuto

+ const RequestModeEnvelope

+ const RequestModeNone

+ const RequestModePlain

+ type ResponseMode string

+ const ResponseModeEnvelope

+ const ResponseModeNone

+ const ResponseModePlain

v0.2.0

Apr 29, 2026

Changes in this version

+ func RegisterAdapter(name string, factory AdapterFactory)

+ func RegisterAuth(name string, provider AuthProvider)

+ func RegisterCodec(name string, codec Codec)

+ func RegisterCrypto(name string, provider CryptoProvider)

+ func RegisterTraceProvider(name string, provider TraceIDProvider)

+ func RegisterValidator(name string, validator Validator)

+ type AdapterFactory func(target any, docs *doc.Docs) (Router, error)

+ type AuthProvider interface

+ Authenticate func(r *http.Request) (*AuthResult, error)

+ func AuthByName(name string) (AuthProvider, error)

+ type AuthResult struct

+ Claims map[string]any

+ Subject string

+ Token string

+ type Codec interface

+ ContentType func() string

+ Encode func(w io.Writer, value any) error

+ func CodecByName(name string) (Codec, error)

+ type CryptoProvider interface

+ Decrypt func(ctx context.Context, ciphertext []byte) ([]byte, error)

+ Encrypt func(ctx context.Context, plaintext []byte) ([]byte, error)

+ func CryptoByName(name string) (CryptoProvider, error)

type Router

+ func NewRouter(name string, target any, docs *doc.Docs) (Router, error)

type TraceIDProvider

+ func TraceProviderByName(name string) (TraceIDProvider, error)

+ type Validator interface

+ Validate func(value any) error

+ func ValidatorByName(name string) (Validator, error)

v0.1.15

Apr 28, 2026

Changes in this version

+ type JSONErrorResponse struct

+ Header JSONResponseInfo

+ func ErrorDoc() JSONErrorResponse

+ type JSONRequestOf struct

+ Content T

+ Header JSONRequestInfo

+ func RequestDoc[T any]() JSONRequestOf[T]

+ type JSONResponseOf struct

+ Content T

+ Header JSONResponseInfo

+ func SuccessDoc[T any]() JSONResponseOf[T]

v0.1.14

Apr 28, 2026

Changes in this version

+ func RegisterTraceIDProvider(provider TraceIDProvider)

+ type TraceIDProvider interface

+ TraceID func(context.Context) string

v0.1.13

Apr 28, 2026

Changes in this version

+ func Delete(router Router, path string, handler http.HandlerFunc, opts ...RouteOption)

+ func Get(router Router, path string, handler http.HandlerFunc, opts ...RouteOption)

+ func OpenAPIHandler(registry *Registry) http.HandlerFunc

+ func Patch(router Router, path string, handler http.HandlerFunc, opts ...RouteOption)

+ func Post(router Router, path string, handler http.HandlerFunc, opts ...RouteOption)

+ func Put(router Router, path string, handler http.HandlerFunc, opts ...RouteOption)

+ func SetRouteVars(vars map[string]string, r *http.Request) *http.Request

+ func SwaggerUIHandler(openAPIURL string) http.HandlerFunc

+ type Components struct

+ SecuritySchemes map[string]SecurityScheme

+ type DataType string

+ const Bool

+ const Float

+ const Int

+ const String

+ type ErrorResponse struct

+ Code string

+ Message string

+ Title string

+ type Info struct

+ Description string

+ Title string

+ Version string

+ type MediaType struct

+ Schema *Schema

+ type OpenAPI struct

+ Components *Components

+ Info Info

+ OpenAPI string

+ Paths map[string]map[string]Operation

+ func GenerateOpenAPI(registry *Registry) OpenAPI

+ type OpenAPIParameter struct

+ Description string

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ type Operation struct

+ Description string

+ Parameters []OpenAPIParameter

+ RequestBody *RequestBodyObject

+ Responses map[string]ResponseObject

+ Security []map[string][]string

+ Summary string

+ Tags []string

+ type Parameter struct

+ Description string

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ Type DataType

+ type Registry struct

+ func NewRegistry(info Info) *Registry

+ func (registry *Registry) AddSecurityScheme(name string, scheme SecurityScheme)

+ func (registry *Registry) Info() Info

+ func (registry *Registry) Register(method string, path string, opts ...RouteOption) Route

+ func (registry *Registry) Routes() []Route

+ func (registry *Registry) SecuritySchemes() map[string]SecurityScheme

+ type RequestBodyObject struct

+ Content map[string]MediaType

+ Required bool

+ type ResponseObject struct

+ Content map[string]MediaType

+ Description string

+ type Route struct

+ Body interface{}

+ BodySchema *Schema

+ Description string

+ Method string

+ Parameters []Parameter

+ Path string

+ Responses []RouteResponse

+ Security []string

+ Summary string

+ Tags []string

+ type RouteOption func(*Route)

+ func Body(body interface{}) RouteOption

+ func BodySchema(schema *Schema) RouteOption

+ func Description(description string) RouteOption

+ func Path(name string, typ DataType, required bool) RouteOption

+ func Query(name string, typ DataType, required bool) RouteOption

+ func Responds(status int, body interface{}) RouteOption

+ func ResponseSchema(status int, description string, schema *Schema) RouteOption

+ func ResponseStatus(status int, body interface{}) RouteOption

+ func ResponseWithDescription(status int, description string, body interface{}) RouteOption

+ func Status(status int, body interface{}) RouteOption

+ func Summary(summary string) RouteOption

+ func Tags(tags ...string) RouteOption

+ type RouteResponse struct

+ Body interface{}

+ Description string

+ Schema *Schema

+ Status int

+ type Router interface

+ Handle func(method string, path string, handler http.HandlerFunc, opts ...RouteOption)

+ func NewMetadataRouter(registry *Registry) Router

+ type Schema struct

+ AdditionalProperties *Schema

+ Description string

+ Enum []interface{}

+ Example interface{}

+ Format string

+ Items *Schema

+ Nullable bool

+ Properties map[string]*Schema

+ Ref string

+ Required []string

+ Type string

+ func SchemaFromType(value interface{}) *Schema

+ type SecurityScheme struct

+ BearerFormat string

+ In string

+ Name string

+ Scheme string

+ Type string

+ func APIKeySecurity(name string, in string) SecurityScheme

+ func BasicSecurity() SecurityScheme

+ func BearerSecurity(format string) SecurityScheme

v0.1.12

Sep 13, 2024

Changes in this version

+ var SkipPaths map[SkipPath]bool

+ func AddSkipPath(path SkipPath, skip bool)

+ func DeleteSkipPath(path SkipPath)

+ type SkipPath string

+ func GenSkipPath(method string, path string) SkipPath

v0.1.11

Aug 16, 2024

v0.1.10

Aug 16, 2024

Changes in this version

+ const RequestDataContextContextKey

+ type RequestContext struct

+ func Context(r *http.Request) *RequestContext

+ func RContext(r *http.Request) (*RequestContext, error)

v0.1.9

Aug 16, 2024

v0.1.8

Aug 16, 2024

Changes in this version

+ func ParamValidatorV0(v any) (string, error)

+ func RegisterParamValidator(paramValidator func(any) (errMsg string, err error))

v0.1.7

Aug 16, 2024

v0.1.6

Aug 16, 2024

Changes in this version

+ var BlankSuccess = true

+ var TraceIDLength = 6

+ var TraceVisibility = 1

v0.1.5

Jul 30, 2024

v0.1.4

Jul 29, 2024

Changes in this version

type JSONRequestInfo

+ DeviceId string

+ DeviceSerial string

+ Latitude string

+ Longitude string

v0.1.3

Aug 27, 2023

v0.1.2

Aug 27, 2023

v0.1.1

Aug 27, 2023

Changes in this version

+ const RequestDataContextKey

+ var DefaultInfoCode = "success"

+ var DefaultSuccessCode = "success"

+ var DefaultWarningCode = "warning"

+ var InternalServerMessage = "An error has occurred please try again later."

+ var InternalServerTitle = "Sorry!"

+ var Print func(string, ...interface{}) = log.Printf

+ var PrintFullEvent bool = false

+ var ResponseCodes = struct{ ... }

+ var SecurityTokenHeaderKey = "SecurityToken"

+ var UnauthorizedMessage = "User not authorized."

+ var UnauthorizedTitle = "Unauthorized!"

+ func GetContextValue(key interface{}, r *http.Request) interface

+ func ProcessRequest(next http.HandlerFunc) http.HandlerFunc

+ func RegisterNewAPIRequestReceiver(receiver core.APIRequestReceiver)

+ func RegisterNewAPISecurityGuarantor(guarantor core.APISecurityGuarantor)

+ func SetContextValue(key, value interface{}, r *http.Request) *http.Request

+ func UpdateRequestContext(requestData *Request, r *http.Request) *http.Request

+ func ValidateMethods(keyMapMethod, method string) bool

+ func Write(data core.ResponseData, w http.ResponseWriter)

+ type EncryptedRequest struct

+ func ProcessEncryptedBody(r *http.Request) (*EncryptedRequest, error)

type Error

+ func Error400() Error

+ func Error401() Error

+ func Error403() Error

+ func Error500() Error

+ func Error500WithMsg(msg string) Error

+ func Error501() Error

+ func ErrorWithMsg(msg string) Error

+ type JSONEncryptedBody struct

+ Data string

+ DeviceUUID string

+ type JSONRequestInfo struct

+ AppBuildVersion string

+ AppName string

+ AppVersion string

+ DeviceBrand string

+ DeviceModel string

+ DeviceType string

+ Lang string

+ OS string

+ OSVersion string

+ SecurityToken string

+ Timezone string

+ UUID string

type JSONResponseInfo

+ Info map[string]string

+ type Request struct

+ func GetRequestContext(r *http.Request) (*Request, error)

+ func ProcessBody(r *http.Request) (*Request, error)

type RequestBasic

+ func (request *RequestBasic) GetEventID() Response

+ func (request *RequestBasic) GetSecurityToken() Response

+ type RequestContextKey string

+ type RequestReceiver struct

+ func (receiver RequestReceiver) GetRouteVar(key string, r *http.Request) string

+ func (receiver RequestReceiver) ProcessBody(r *http.Request) (*core.RequestData, error)

+ func (receiver RequestReceiver) ProcessEncryptedBody(r *http.Request) (*core.RequestEncryptedData, error)

+ type RequestReceiverV2 struct

+ func (receiver RequestReceiverV2) GetRouteVar(key string, r *http.Request) string

+ func (receiver RequestReceiverV2) ProcessBody(r *http.Request) (*core.RequestData, error)

+ func (receiver RequestReceiverV2) ProcessEncryptedBody(r *http.Request) (*core.RequestEncryptedData, error)

+ type SecurityGuaranter struct

+ func (guaranter *SecurityGuaranter) ValidateBasicToken(token string) (client, secret string, valid bool)

+ func (guaranter *SecurityGuaranter) ValidateCustomToken(token string, validator core.CustomTokenValidator) (json.RawMessage, bool)

type Success

+ func Success200() Success

+ func Success201() Success

+ func SuccessWithContent(content interface{}) Success

+ func SuccessWithMsg(msg string) Success

v0.1.0

Aug 27, 2023

Changes in this version

+ const MethodGetKey

+ const MethodPatchKey

+ const MethodPostKey

+ const MethodPutKey

+ const PPMethodsKey

+ const PPPGMethodsKey

+ const PPPMethodsKey

+ var CustomTokenPrefix = "Bearer"

+ var CustomTokenValidatorFunc core.CustomTokenValidator

+ var DefaultBasicUnauthorizedMsg = "Invalid basic token"

+ var DefaultBearerUnauthorizedMsg = "Invalid bearer token"

+ var DefaultCustomUnauthorizedMsg = fmt.Sprintf("Invalid %v token", CustomTokenPrefix)

+ var DefaultErrorMessage = "The service has not completed the operation!"

+ var DefaultErrorTitle = "Error response!"

+ var DefaultInfoMessage = "The request has been successful!"

+ var DefaultInfoTitle = "Information!"

+ var DefaultInvalidAuthHeaderMsg = "Invalid Authorization header!"

+ var DefaultSuccessMessage = "The request has been successful!"

+ var DefaultSuccessTitle = "Successful!"

+ var DefaultUnauthorizedTitle = "Unauthorized!"

+ var DefaultWarningMessage = "The application has been successful but with potential problems!"

+ var DefaultWarningTitle = "Alert!"

+ var ErrorType core.ResponseType = "error"

+ var EventIDHeaderKey = "EventID"

+ var Fatal func(...interface{}) = log.Fatal

+ var GetRouteVar func(string, *http.Request) string = func(string, *http.Request) string

+ var InformativeType core.ResponseType = "info"

+ var MiddlewaresChain = core.MiddlewaresChain

+ var Password = "admin"

+ var PrintError func(...interface{}) = log.Print

+ var Printf func(string, ...interface{}) = log.Printf

+ var RequestBody = NewRequestBodyMiddleware(PPPGMethodsKey)

+ var SessionIDHeaderKey = "SessionID"

+ var SuccessType core.ResponseType = "success"

+ var UserIDHeaderKey = "UserID"

+ var Username = "admin"

+ var WarningType core.ResponseType = "warning"

+ func AddNewMapMethod(key string, methods []string)

+ func BasicToken(next http.HandlerFunc) http.HandlerFunc

+ func ContentExtractor(next http.HandlerFunc) http.HandlerFunc

+ func CustomToken(next http.HandlerFunc) http.HandlerFunc

+ func LogRequest(method, uri, eventID, form string, headers http.Header, rawBody []byte)

+ func LogResponse(res *httptest.ResponseRecorder)

+ func NewRequestBodyMiddleware(keyListMethods string) core.Middleware

+ func RegisterNewAPIRequestValidator(v core.APIRequestValidator)

+ func RegisterNewAPIResponseFormatter(f core.APIResponseFormatter)

+ func RegisterNewAPIResponseWriter(f core.APIResponseWriter)

+ func RequestHeaderJSON(next http.HandlerFunc) http.HandlerFunc

+ func RequestHeaderSession(next http.HandlerFunc) http.HandlerFunc

+ func ValidateBasicToken(token string) (client, secret string, valid bool)

+ func ValidateCustomToken(token string) (json.RawMessage, bool)

+ type Error core.ResponseData

+ func (err Error) Write(w http.ResponseWriter)

+ type Header struct

+ AppBuildVersion string

+ AppName string

+ AppVersion string

+ DeviceBrand string

+ DeviceModel string

+ DeviceType string

+ DeviceUUID string

+ Lang string

+ OS string

+ OSVersion string

+ Timezone string

+ Token string

+ type Informative core.ResponseData

+ func (info Informative) Write(w http.ResponseWriter)

+ type JSONRequest struct

+ Content json.RawMessage

+ Header Header

+ type JSONResponse struct

+ Content interface{}

+ Header JSONResponseInfo

+ type JSONResponseInfo struct

+ Action string

+ AdditionalInfo map[string]string

+ Code string

+ EventID string

+ Message string

+ Title string

+ Token string

+ Type core.ResponseType

+ type RequestBasic struct

+ EventID string

+ HTTPReq *http.Request

+ JSONStruct interface{}

+ SessionID string

+ UserID string

+ func (request *RequestBasic) GetRequestBasicInfo() Response

+ func (request *RequestBasic) GetRequestFullInfo() Response

+ func (request *RequestBasic) GetSessionID() Response

+ func (request *RequestBasic) GetTraceID() Response

+ func (request *RequestBasic) GetUserID() Response

+ func (request *RequestBasic) UnmarshalBody() Response

+ type RequestValidator struct

+ func (v RequestValidator) GetRouteVar(key string, r *http.Request) string

+ func (v RequestValidator) ValidateRequest(r *http.Request) (*core.RequestData, error)

+ type Response interface

+ Write func(w http.ResponseWriter)

+ func GetHeaderValueBool(key string, r *http.Request) (bool, Response)

+ func GetHeaderValueFloat64(key string, r *http.Request) (float64, Response)

+ func GetHeaderValueInt(key string, r *http.Request) (int, Response)

+ func GetHeaderValueInt64(key string, r *http.Request) (int64, Response)

+ func GetHeaderValueString(key string, r *http.Request) (string, Response)

+ func GetQueryParamValueBool(queryParamName string, r *http.Request) (bool, Response)

+ func GetQueryParamValueFloat64(queryParamName string, r *http.Request) (float64, Response)

+ func GetQueryParamValueInt(queryParamName string, r *http.Request) (int, Response)

+ func GetQueryParamValueInt64(queryParamName string, r *http.Request) (int64, Response)

+ func GetQueryParamValueString(queryParamName string, r *http.Request) (string, Response)

+ func GetRouteVarValueBool(urlVarName string, r *http.Request) (bool, Response)

+ func GetRouteVarValueFloat64(urlVarName string, r *http.Request) (float64, Response)

+ func GetRouteVarValueInt(urlVarName string, r *http.Request) (int, Response)

+ func GetRouteVarValueInt64(urlVarName string, r *http.Request) (int64, Response)

+ func GetRouteVarValueString(urlVarName string, r *http.Request) (string, Response)

+ func UnmarshalBody(v interface{}, r *http.Request) Response

+ type ResponseFormatter struct

+ func (f ResponseFormatter) Format(data core.ResponseData) *core.ResponseFormatted

+ type ResponseWriter struct

+ func (r ResponseWriter) Write(response *core.ResponseFormatted, w http.ResponseWriter)

+ type Security struct

+ func (s *Security) ValidateBasicToken(token string) (client, secret string, valid bool)

+ func (s *Security) ValidateCustomToken(token string, validator core.CustomTokenValidator) (json.RawMessage, bool)

+ type Success core.ResponseData

+ func (success Success) Write(w http.ResponseWriter)

+ type ValidateCredentials func(string, string) bool

+ var ValidateBasicAuthCredentialsFunc ValidateCredentials = validateCredentials

+ type Warning core.ResponseData

+ func (warning Warning) Write(w http.ResponseWriter)

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