Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.4.0

Aug 8, 2025

Changes in this version

+ const StateAuthorized

+ const StateInit

+ const StateInvalid

+ const StateUndefined

v0.3.3

Nov 30, 2023

v0.3.2

Nov 23, 2023

v0.3.1

Nov 23, 2023

v0.3.0

Nov 22, 2023

v0.2.2

Feb 18, 2023

v0.2.1

Dec 8, 2022

v0.2.0

Aug 31, 2022

v0.1.0

Aug 28, 2022

Changes in this version

+ const InitRoute

+ const LoginExpiresAfter

+ const LoginRoute

+ const LogoutRoute

+ const MsgStatus

+ const NamespacePrefix

+ var ErrApiInvocationError = errors.New("api invocation error")

+ var ErrInternalError = errors.New("internal error")

+ var ErrInvalidRoute = errors.New("invalid route")

+ var ErrMissingCredentials = errors.New("missing credentials")

+ var ErrNotImplemented = errors.New("not implemented")

+ func CreateSimpleToken() string

+ func DefaultEndpoint(c echo.Context) error

+ func Duration(d time.Duration, dicimal int) time.Duration

+ func ErrorResponse(c echo.Context, status int, err error, hint string) error

+ func HandleFileUpload(ctx context.Context, req *http.Request, location, formName string) (string, error)

+ func InitEndpoint(c echo.Context) error

+ func LoginEndpoint(c echo.Context) error

+ func LogoutEndpoint(c echo.Context) error

+ func NewTransport(logger logger.Logger, transport http.RoundTripper) (*http.Client, error)

+ func ParseRange(r string) (int64, int64)

+ func StandardResponse(c echo.Context, status int, res interface{}) error

+ func WithAuthEndpoints(e *echo.Echo) *echo.Echo

+ type Client struct

+ func NewClient(cfg *settings.DialSettings, logger logger.Logger) (*Client, error)

+ func (c *Client) DELETE(uri string, request, response interface{}) (int, error)

+ func (c *Client) GET(uri string, response interface{}) (int, error)

+ func (c *Client) InitCommand(cfg *settings.DialSettings) error

+ func (c *Client) LoginCommand(token string) (*StatusObject, error)

+ func (c *Client) LogoutCommand() error

+ func (c *Client) POST(uri string, request, response interface{}) (int, error)

+ func (c *Client) PUT(uri string, request, response interface{}) (int, error)

+ type LoggingTransport struct

+ InnerTransport http.RoundTripper

+ Logger logger.Logger

+ func (t *LoggingTransport) RoundTrip(req *http.Request) (*http.Response, error)

+ type RelevantHeaders struct

+ Forwarded string

+ Range string

+ Referer string

+ UserAgent string

+ XForwardedFor string

+ XForwwardedHost string

+ func ExtractHeaders(r *http.Request) RelevantHeaders

+ func (h *RelevantHeaders) Ranges() (int64, int64)

+ type StatusObject struct

+ Message string

+ RootError error

+ Status int

+ func NewErrorStatus(s int, e error, hint string) StatusObject

+ func NewStatus(s int, m string) StatusObject

+ func (so *StatusObject) Error() string

+ func (so *StatusObject) String() string