api

package

v0.0.0-...-d4ae18a Latest Latest Go to latest Published: Dec 29, 2020 License: MIT Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/thetogi/YReserve2

Links

Open Source Insights

Documentation ¶

Index ¶

func CheckCreatedStatus(t *testing.T, statusCode int)
func CheckOkStatus(t *testing.T, statusCode int)
func GetTestUniqueEmail() string
func GetTestUser() *model.User
type API
- func NewAPI(router *mux.Router, appOption *app.AppOption, config *model.Config, ...) *API
type APITest
- func GetApiTest() *APITest
- func SetupApiTest() *APITest
type Router

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CheckCreatedStatus ¶

func CheckCreatedStatus(t *testing.T, statusCode int)

func CheckOkStatus ¶

func CheckOkStatus(t *testing.T, statusCode int)

func GetTestUniqueEmail ¶

func GetTestUniqueEmail() string

func GetTestUser ¶

func GetTestUser() *model.User

Types ¶

type API ¶

type API struct {
	MainRouter *mux.Router
	AppOption  *app.AppOption
	Config     *model.Config
	Metrics    metrics.Metrics
	Log        logger.Logger
	Router     *Router
}

func NewAPI ¶

func NewAPI(router *mux.Router, appOption *app.AppOption, config *model.Config, metrics metrics.Metrics, logger logger.Logger) *API

func (*API) HealthCheck ¶

func (a *API) HealthCheck(c *wrapper.RequestContext, w http.ResponseWriter, r *http.Request)

HealthCheck func is used to check health check status

func (*API) InitHealthCheck ¶

func (a *API) InitHealthCheck()

func (*API) InitSetting ¶

func (a *API) InitSetting()

func (*API) InitUser ¶

func (a *API) InitUser()

func (*API) InitUserDetail ¶

func (a *API) InitUserDetail()

func (*API) InitUserLogin ¶

func (a *API) InitUserLogin()

type APITest ¶

type APITest struct {
	API         *API
	MySQLDocker *docker.MysqlDocker
}

func GetApiTest ¶

func GetApiTest() *APITest

func SetupApiTest ¶

func SetupApiTest() *APITest

func (*APITest) CheckValidTestUser ¶

func (at *APITest) CheckValidTestUser(t *testing.T, expectedUser *model.User, receivedUser *model.User)

func (*APITest) CleanUpApiTest ¶

func (at *APITest) CleanUpApiTest()

func (*APITest) CreateUserAuthFromTestAPI ¶

func (at *APITest) CreateUserAuthFromTestAPI(t *testing.T, api *API, user *model.User) *model.UserAuth

type Router ¶

type Router struct {
	Root      *mux.Router // ”
	AdminRoot *mux.Router // 'admin'
	APIRoot   *mux.Router // 'api/v1'
	User      *mux.Router // 'api/v1/user'
	Setting   *mux.Router // 'api/v1/setting'
	Metrics   *mux.Router // 'api/v1/metrics'
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
middleware
wrapper

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