RapiDoc is an OpenAPI-genereted API reference documentation generator that can be used to produce documentation for your APIs quickly.
In the dev portal,
RapiDoc can be used to create the API documentations just setting up the link to your OpenAPI specification.
Microservice creation for
To create an instance of
- Go to the
- Create a new microservice using the
Microlc RapiDoc Pluginin the
Dev Portalcategory of the marketplace;
- Configure the microservice with a custom name and description;
- Complete the creation to deploy an instance of
RapiDoc endpoint configuration
- Create a new endpoint;
- Define the
Base pathwhere you want to expose
- As type, use
- Select the microservice name used for
- Complete the creation.
After that, the situation should be similar to the following:
Like all the plugins of
micro-lc you should refer to the core configuration section
for the setup and to correctly configure RapiDoc you must set one
- openApiSpecUrl : the url to your
Here follows a full configuration example:
"icon": "fas fa-link",
After a deployment, your new Dev Portal should be exposed at the
/ path of your host (e.g.
and should be similar to the following:
We suggest to use RapiDoc to set up the Dev Portal, but in case of
small (<~300kb) OpenApi specification file you can consider to use Redoc; for this plugin, we highly suggest to read the ReDoc Documentation