Skip to content

Endpoints

Jump to bottom
Rico Suter edited this page Jul 2, 2021 · 16 revisions

An Endpoint tracks one logical and public API component of a Service.

The structure looks as following:

  • Endpoints
    • Endpoint Documents (Versions): Each Endpoint can have a specific version served per Environment. Older versions are kept so that versions can be compared and the consumer has a history of versions.
    • Environment Endpoints: Describes the current version deployed to a specific Service version and Environment

There are multiple types of Endpoints:

Usually there is only one Endpoint per specification type (i.e. a Service usually has only one RESTful web api).

Environment Endpoints

An Endpoint can have metadata per Environment where you can define the URL to the current Endpoint specification and the actual API URL in the given Environment or to the live Swagger UI.

Statistics

To enable OpenAPI Endpoint statistics you need to configure Application Insights credentials in the Environment under "Monitoring" (Seq is currently not supported).

In the Service of the Endpoint you need to specify a filter for the particular Service (or "true" to include all logs).

With this information Apimundo will retrieve the requests logs and group them by the OpenAPI operations.

Clone this wiki locally