api

Documentation

Index

• type App
  • func (app *App) Initialize() error
  • func (app *App) InitializeSchema(quiet ...bool) error
  • func (app *App) MountStaticRoutes()
  • func (app *App) Start(customRouter func())
• type Options

Types

type App

type App struct {
	Router        *mux.Router
	DB            *gorm.DB
	MartaClient   clients.MartaClient
	TwitterClient clients.TwitterClient
	Options       Options
}

func (*App) Initialize

func (app *App) Initialize() error

func (*App) InitializeSchema

func (app *App) InitializeSchema(quiet ...bool) error

func (*App) MountStaticRoutes

func (app *App) MountStaticRoutes()

func (*App) Start

func (app *App) Start(customRouter func())

@securityDefinitions.apikey ApiKeyAuth @in header @name Authorization

type Options

type Options struct {
	TwitterClientID     string `long:"twitter-client-id" env:"TWITTER_CLIENT_ID" description:"the client id for the twitter account"`
	TwitterClientSecret string `long:"twitter-client-secret" env:"TWITTER_CLIENT_SECRET" description:"the client secret for the twitter account"`
	MartaAPIKey         string `long:"marta-api-key" env:"MARTA_API_KEY" description:"marta api key"`
	TwitterCacheTTL     int    `` /* 130-byte string literal not displayed */
	MartaCacheTTL       int    `long:"marta-cache-ttl" env:"MARTA_CACHE_TTL" default:"15" description:"how long we keep the marta responses" required:"true"`
	DBConnectionString  string `long:"db-connection-string" env:"DB_CONNECTION_STRING"`
	AdminAPIKey         string `long:"admin-api-key" env:"ADMIN_API_KEY" description:"admin api key"`
	Servicedomain       string `` /* 146-byte string literal not displayed */
	RailRunner          bool   `long:"rail-runner" env:"RAIL_RUNNER" description:"enable the rail runner"`
}