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
- Variables
- type Client
- func (_c *Client) ForHost(host string) *Client
- func (_c *Client) List(r *http.Request) (res *http.Response, err error)
- func (_c *Client) List_Get(ctx context.Context, url string) (res *http.Response, err error)
- func (_c *Client) List_Post(ctx context.Context, url string, contentType string, body any) (res *http.Response, err error)
- type MulticastClient
- func (_c *MulticastClient) ForHost(host string) *MulticastClient
- func (_c *MulticastClient) List(ctx context.Context, r *http.Request) <-chan *pub.Response
- func (_c *MulticastClient) List_Get(ctx context.Context, url string) <-chan *pub.Response
- func (_c *MulticastClient) List_Post(ctx context.Context, url string, contentType string, body any) <-chan *pub.Response
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 an interface to calling the endpoints of the openapiportal.core microservice. This simple version is for unicast calls.
func (*Client) List ¶
List displays links to the OpenAPI endpoint of all microservices that provide one on the request's port.
If a request is not provided, it defaults to the URL of the endpoint. Otherwise, it is resolved relative to the URL of the endpoint.
func (*Client) List_Get ¶
List_Get performs a GET request to the List endpoint.
List displays links to the OpenAPI endpoint of all microservices that provide one on the request's port.
If a URL is not provided, it defaults to the URL of the endpoint. Otherwise, it is resolved relative to the URL of the endpoint.
func (*Client) List_Post ¶
func (_c *Client) List_Post(ctx context.Context, url string, contentType string, body any) (res *http.Response, err error)
List_Post performs a POST request to the List endpoint.
List displays links to the OpenAPI endpoint of all microservices that provide one on the request's port.
If a URL is not provided, it defaults to the URL of the endpoint. Otherwise, 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 an interface to calling the endpoints of the openapiportal.core microservice. This advanced version is for multicast calls.
func NewMulticastClient ¶
func NewMulticastClient(caller service.Publisher) *MulticastClient
NewMulticastClient creates a new multicast client to the openapiportal.core microservice.
func (*MulticastClient) ForHost ¶
func (_c *MulticastClient) ForHost(host string) *MulticastClient
ForHost replaces the default hostname of this client.
func (*MulticastClient) List ¶
List displays links to the OpenAPI endpoint of all microservices that provide one on the request's port.
If a request is not provided, it defaults to the URL of the endpoint. Otherwise, it is resolved relative to the URL of the endpoint.
func (*MulticastClient) List_Get ¶
List_Get performs a GET request to the List endpoint.
List displays links to the OpenAPI endpoint of all microservices that provide one on the request's port.
If a URL is not provided, it defaults to the URL of the endpoint. Otherwise, it is resolved relative to the URL of the endpoint.
func (*MulticastClient) List_Post ¶
func (_c *MulticastClient) List_Post(ctx context.Context, url string, contentType string, body any) <-chan *pub.Response
List_Post performs a POST request to the List endpoint.
List displays links to the OpenAPI endpoint of all microservices that provide one on the request's port.
If a URL is not provided, it defaults to the URL of the endpoint. Otherwise, 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.
Source Files