openapi

Documentation

Index

• type Endpoint
• type Service
  • func (s *Service) MarshalJSON() ([]byte, error)

Types

type Endpoint

type Endpoint struct {
	Type        string
	Name        string
	Path        string
	Summary     string
	Description string
	InputArgs   interface{}
	OutputArgs  interface{}
	Method      string
}

Endpoint describes a single endpoint of a microservice, such as an RPC function.

type Service

type Service struct {
	ServiceName string
	Description string
	Version     int
	Endpoints   []*Endpoint
	RemoteURI   string
}

Service is populated with the microservice's specs in order to generate its OpenAPI document.

func (*Service) MarshalJSON

func (s *Service) MarshalJSON() ([]byte, error)

MarshalJSON produces the JSON representation of the OpenAPI document of the service.