bootstrap

Documentation

Overview

Package Name: bootstrap File Name: bootstrap.go Abstract: Wrapper for invoking all the module's dependencies and starting the API by loading the essential initial components that allow it to run and perform more complex tasks.

Author: Alejandro Modroño <alex@sureservice.es> Created: 07/08/2023 Last Updated: 07/24/2023

MIT License

Copyright 2023 Alejandro Modroño Vara

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Name: bootstrap File Name: routes.go Abstract: The wrapper for setting up all the routes.

Author: Alejandro Modroño <alex@sureservice.es> Created: 07/08/2023 Last Updated: 07/24/2023

MIT License

Copyright 2023 Alejandro Modroño Vara

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• Variables
• type Route
• type Routes
  • func GetRoutes(userRoutes users.UsersRoutes, authRoutes auth.AuthRoutes) Routes
  • func (r Routes) Setup()

Variables

var Module = fx.Options(

	lib.Module,
	middlewares.Module,

	users.Context,
	auth.Context,

	fx.Provide(GetRoutes),

	fx.Invoke(registerHooks),
)

Module exports for fx

Types

type Route

type Route interface {
	Setup()
}

Route interface

type Routes

type Routes []Route

Routes contains multiple routes

func GetRoutes

func GetRoutes(
	userRoutes users.UsersRoutes,
	authRoutes auth.AuthRoutes,
) Routes

GetRoutes provides all the routes

func (Routes) Setup

func (r Routes) Setup()

Sets up all the routes