api

package

v0.3.0 Latest Latest Go to latest Published: Jun 11, 2023 License: AGPL-3.0 Imports: 3 Imported by: 0

Details

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

Repository

github.com/shiroyk/cloudcat

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api the api service

Constants ¶

View Source

const (
	// DefaultTimeout the default timeout
	DefaultTimeout = time.Minute
	// DefaultAddress the api default address
	DefaultAddress = "localhost:8080"
)

Variables ¶

This section is empty.

Functions ¶

func Server ¶

func Server(opt Options) *http.Server

Server the api service

Types ¶

type Options ¶

type Options struct {
	Token      string        `yaml:"token"`
	Address    string        `yaml:"address"`
	Timeout    time.Duration `yaml:"timeout"`
	RequestLog bool          `yaml:"request-log"`
}

Options the api server configuration

Source Files ¶

View all Source files

server.go

Directories ¶

Path	Synopsis
v1 Package v1 the version 1 api	Package v1 the version 1 api

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