Documentation
¶
Overview ¶
Package openapiportalapi implements the public API of the openapiportal.core microservice, including clients and data structures.
The OpenAPI microservice lists links to the OpenAPI endpoint of all microservices that provide one on the requested port.
Index ¶
Constants ¶
const Hostname = "openapiportal.core"
Hostname is the default hostname of the microservice: openapiportal.core.
Variables ¶
var (
URLOfList = httpx.JoinHostAndPath(Hostname, `//openapi:0`)
)
Fully-qualified URLs of the microservice's endpoints.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a lightweight proxy for making unicast calls to the openapiportal.core microservice.
func NewClient ¶
NewClient creates a new unicast client proxy to the openapiportal.core microservice.
func (Client) ForHost ¶
ForHost returns a copy of the client with a different hostname to be applied to requests.
func (Client) List ¶
func (_c Client) List(ctx context.Context, method string, relURL string, contentType string, body any) (res *http.Response, err error)
List displays links to the OpenAPI endpoint of all microservices that provide one on the request's port.
If a URL is provided, it is resolved relative to the URL of the endpoint. If the body if of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON. If a content type is not explicitly provided, an attempt will be made to derive it from the body.
type MulticastClient ¶
type MulticastClient struct {
// contains filtered or unexported fields
}
MulticastClient is a lightweight proxy for making multicast calls to the openapiportal.core microservice.
func NewMulticastClient ¶
func NewMulticastClient(caller service.Publisher) MulticastClient
NewMulticastClient creates a new multicast client proxy to the openapiportal.core microservice.
func (MulticastClient) ForHost ¶
func (_c MulticastClient) ForHost(host string) MulticastClient
ForHost returns a copy of the client with a different hostname to be applied to requests.
func (MulticastClient) List ¶
func (_c MulticastClient) List(ctx context.Context, method string, relURL string, contentType string, body any) <-chan *pub.Response
List displays links to the OpenAPI endpoint of all microservices that provide one on the request's port.
If a URL is provided, it is resolved relative to the URL of the endpoint. If the body if of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON. If a content type is not explicitly provided, an attempt will be made to derive it from the body.
func (MulticastClient) WithOptions ¶ added in v1.13.1
func (_c MulticastClient) WithOptions(opts ...pub.Option) MulticastClient
WithOptions returns a copy of the client with options to be applied to requests.
Source Files