api

package

v0.2.0 Latest Latest Go to latest Published: Jul 29, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Server hold the gin engine and any clients we need for the API.

func NewServer() Server

NewServer returns a new instance of Server.

func (s *Server) Setup()

Setup sets any global middlewares then initializes the API.

func (s *Server) WithAPIKey(apiKey string)

WithAPIKey sets the API key required for create and delete operations.

func (s *Server) WithBuilder(b gcloud.CloudRunCommandBuilder)

WithBuilder sets the gcloud command builder.

func (s *Server) WithEngine(e *gin.Engine)

WithEngine sets the gin engine instance for the server.

func (s *Server) WithFiatClient(fc fiat.Client)

WithFiatClient sets the Fiat Client.

func (s *Server) WithSQLClient(sc sql.Client)

WithSQLClient sets the sql client instance for the server.

Path	Synopsis
v1