Skip to main content
Version: 9.x (Current)

Endpoints Configuration

In this paragraph, we will describe the endpoints that must be configured to correctly use the dev portal.

We divided the configuration into macro areas: all these actions must be done in the Endpoints section of the console.

info

For each endpoint:

  1. Create a new endpoint as specified in the Endpoint column;
  2. Point this URL to the microservice specified in the Microservice column;
  3. Use the Rewrite Base Path specified.

General configuration

Configure the endpoint exposing the aggregated frontend plugins:

EndpointMicroserviceRewrite Base Path
/aggregated-dev-portal-frontends/

Backoffice configuration

Expose the APIs necessary for the creation of the backoffice section:

EndpointMicroserviceRewrite Base Path
/back-office/apibackoffice-micro-lc-backend/
/filesfiles-service/

Dev portal configuration

Expose the APIs necessary for the creation of the dev portal section:

EndpointMicroserviceRewrite Base Path
/dev-portal/apidev-portal-micro-lc-backend/
/bffdev-portal-marketplace-backend/
/docusaurusdev-portal-micro-lc-docusaurus/
/documentation/assetsdev-portal-micro-lc-docusaurus/assets
/dev-portal/documentation/assetsdev-portal-micro-lc-docusaurus/assets
/dev-portal/api-portal/apiswagger aggregator/
/dev-portal/documentation/search-index.jsondev-portal-micro-lc-docusaurus/search-index.json

CRUD configuration

Expose the following CRUD endpoints, in order to make the marketplace elements configurable on the backoffice:

EndpointCRUD Collection
/componentscomponents
/categoriescategories
/tagstags
/requestsrequests
/iconsicons

For each endpoint:

  1. Create a new endpoint called as specified;
  2. Point this URL to the CRUD with the corresponding name;

Advanced configuration

For this configuration step, move to the Advanced section of the console and select the api-gateway microservice.

info

These endpoints allow the two micro-lc instances, created respectively for the backoffice and dev portal sections, to exist simultaneously without conflicts.

Search for the following files and paste the content below:

  • maps-proxyUrl.before.map
# micro-lc dev portal
"~^\w+-/dev-portal/.+/api/v1/microlc(?<path>[/\?].*|$)$" "/v1/microlc$path";

# micro-lc backoffice
"~^\w+-/back-office/.+/api/v1/microlc(?<path>[/\?].*|$)$" "/v1/microlc$path";

# micro-lc user info
"~^\w+-/.+/userinfo(?<path>[/\?].*|$)$" "/userinfo$path";
  • maps-proxyName.before.map
# micro-lc dev portal
"~^(secreted|unsecreted)-1-GET-/dev-portal/.*/api/v1/microlc/.*" "dev-portal-micro-lc-backend";

# micro-lc backoffice
"~^(secreted|unsecreted)-1-GET-/back-office/.*/api/v1/microlc/.*" "backoffice-micro-lc-backend";

# micro-lc user info
"~^(secreted|unsecreted)-1-\w+-/.*/userinfo([/\?].*|$)$" "auth0-client";
  • root-location-extension.conf
location = / {
include /etc/nginx/customization.d/header-debug.conf;

return 302 '$original_request_scheme://$original_request_host/dev-portal/';
}

location = /dev-portal {
include /etc/nginx/customization.d/header-debug.conf;

return 302 '$original_request_scheme://$original_request_host/dev-portal/';
}

location = /back-office {
include /etc/nginx/customization.d/header-debug.conf;

return 302 '$original_request_scheme://$original_request_host/back-office/';
}

caution

Please ignore any red feedback that may appear when pasting this content within the advanced section files.

Final result

At the end of this configuration, the situation should look like this:

Final endpoints result