svc

package

v0.0.1 Latest Latest Go to latest Published: Jul 2, 2020 License: MIT Imports: 5 Imported by: 3

Details

This section is empty.

This section is empty.

func NullEndpoint(c *gin.Context)

NullEndpoint just respondes with an empty 200

func RobotsEndpoint(c *gin.Context)

RobotsEndpoint maps to GET /robots.txt

func StandardAPIResponse(c *gin.Context, err error)

StandardAPIResponse is the default way to respond to API requests

func StandardJSONResponse(c *gin.Context, res interface{}, err error)

StandardJSONResponse is the default way to respond to API requests

type APIService struct {
	// contains filtered or unexported fields
}

APIService abstracts an API endpoint

func New(addr ...string) (*APIService, error)

New creates a new service instance on addr

func (api *APIService) AddDefaultEndpoints()

AddDefaultEndpoints adds a couple of simple handlers to the router

func (api *APIService) Router() *gin.Engine

Router gives access to the router instance

func (api *APIService) ServeStaticAssets(path, dir string)

ServeStaticAssets adds handlers to serve static assets

func (api *APIService) Start()

Start attaches the router to a server