Categorygithub.com/tedforv/restfulrouter
modulepackage
1.0.0
Repository: https://github.com/tedforv/restfulrouter.git
Documentation: pkg.go.dev

# README

RestfulRouter

Restful API pattern, seperate the url into "controller/action" pattern

# Functions

ComposeCustomMappingKey which used in custom mapping logic, join the http method and the path into a string.
Error response error message.
GinResponseObj convert ResponseObj into gin.H.
RegisterAPIRoute is the main function.use this func can auto register the method to the certain request url.
RegisterGroupAPIRoute as RegisterAPIRout, the only difference between them is group method can has pre base url.

# Constants

ControllerSuffix defin the suffix of controller struct.
ErrorControllerName is a message of controller wrong name.
KeySeperator seperator for keys.
RError is error status.
ROther is other status.
RSuccess is success status.

# Structs

BaseController implement IBaseController, cover the base functions with 404 response.
ResponseObj define a response object.

# Interfaces

IBaseController that satisfies restfulrouter.IBaseController can beauto mapping request to the certain method.

# Type aliases

GinHandler define a func for gin.
ResponseCode define the new type for response code.