This service can be added to your project by visiting Mia-Platform Marketplace and creating a new microservice from the API Portal plugin.
In order to access the Documentation Portal you should also create an endpoint that should expose your microservice at the following path:
/documentations/api-portal. For this endpoint you should also unset the following flags:
- Show in API Portal (Details card)
- Support only JSON format on request (Configure microservice gateway card)
- Support only JSON format on response (Configure microservice gateway card)
After this, in the Security Management card you should also set the User Group Permission to
Lastly, in the Routes card, you should create a route with
GET as http verb and
/ as route path. For this newly created route uncheck the
inherited checkbox for the User Group Permission and set its value to
If you want to expose the Api Portal on an additional path, you have also to expose the Swagger Aggregator on the correct corresponding path.
For instance, if you expose the Api Portal on
/my-api-portal, then you need to expose the Swagger Aggregator on
/my-api-portal/api. Otherwise, the Api Portal would not be able to get the swagger definitions.
API Portal plugin does not require any configuration file.
Please, be aware that the API Portal is public by default, so the users do not need to perform any login step to view your API Portal.
You can block unauthorized users to access the API Portal by checking
Authentication required to the
GET / route of the endpoint that exposes the API Portal. Doing so, only users with the cookie can access it, but the login page for setting the cookie is not autogenerated, hence you need to configure the login process by yourself.
- HTTP_PORT (required, default
8080): port where the web server is exposed.