openapiportal

Documentation

Overview

Package openapiportal implements the openapiportal.core microservice.

The OpenAPI microservice lists links to the OpenAPI endpoint of all microservices that provide one on the requested port.

Index

• Constants
• type Mock
  • func NewMock() *Mock
• type Service
  • func NewService() *Service
  • func (svc *Service) Init(initializer func(svc *Service)) *Service
  • func (svc *Service) List(w http.ResponseWriter, r *http.Request) (err error)
  • func (svc *Service) OnShutdown(ctx context.Context) (err error)
  • func (svc *Service) OnStartup(ctx context.Context) (err error)

Constants

const Hostname = "openapiportal.core"

Hostname is the default hostname of the microservice: openapiportal.core.

const SourceCodeSHA256 = "33fcef9ff87afb9a3c018645522b1942bc6dc7dd1f381db37443db3a1c97a819"

const Timestamp = "2024-08-01T15:49:25.351407Z"

const Version = 105

Types

type Mock

type Mock = intermediate.Mock

Mock is a mockable version of the openapiportal.core microservice, allowing functions, event sinks and web handlers to be mocked.

func NewMock

func NewMock() *Mock

New creates a new mockable version of the microservice.

type Service

type Service struct {
	*intermediate.Intermediate // DO NOT REMOVE
}

Service implements the openapiportal.core microservice.

The OpenAPI microservice lists links to the OpenAPI endpoint of all microservices that provide one on the requested port.

func NewService

func NewService() *Service

NewService creates a new openapiportal.core microservice.

func (*Service) Init

func (svc *Service) Init(initializer func(svc *Service)) *Service

Init enables a single-statement pattern for initializing the microservice.

svc.Init(func(svc Service) {
	svc.SetGreeting("Hello")
})

func (*Service) List

func (svc *Service) List(w http.ResponseWriter, r *http.Request) (err error)

List displays links to the OpenAPI endpoint of all microservices that provide one on the request's port.

func (*Service) OnShutdown

func (svc *Service) OnShutdown(ctx context.Context) (err error)

OnShutdown is called when the microservice is shut down.

func (*Service) OnStartup

func (svc *Service) OnStartup(ctx context.Context) (err error)

OnStartup is called when the microservice is started up.