This microservice is based upon clm-core and extends the basic functionalities with additional features

CLM-EXT-SWAGGER

Serves as documentation to display all routes of either clm-extensions or the clm-core. Dynamically receives the swagger configuration of the deployed microservices.

Requirements

• MariaDB, set up locally. This service leverages a database (DB) as the cornerstone for storing documents persistently. To establish a connection with MariaDB, it is essential that the database is secured through username and password authentication. Therefore, in order to run this service it is required to create a database within the MariaDB and configure it with a username and password for access control

  • MariaDB Installation: https://mariadb.com/kb/en/getting-installing-and-upgrading-mariadb/
  • For setting up the password of a user: https://mariadb.com/kb/en/set-password/

• Node.js 20.x: https://nodejs.org/en/download

Folder Structure

root

├── api-docs # Open API 3.0.0 definition as .yaml file documenting all routes and data models this service offers.

├── docs # Developer documentation of all functions, classes, interfaces, types this service exposes as an npm package.

├── dist # The built TypeScript project transpiled to JavaScript.

└── src # Business-relevant logic for this web server.

Architecture

The Entity Relationship Model of the Open Core is shown above.

Setup for Testing the Webserver

1. The service's configuration can be customized by referring to the .env file. Within this file, the MARIA_CONFIG variable should be updated with the appropriate values to reflect the user's specific database settings. Refer to the MARIA_CONFIG variable in the table below to see which comma seperated value refers to which respective database setting.
2. Copy .env.default to .env and overwrite needed properties.

Following table gives an overview of the settings you can change through the environment variables

Name	Example	Required (Yes/No)	Description
PORT	3010	Yes	The port on which the service should be deployed.
DEPLOY_URL	HOST_PROTOCOL://HOST_ADDRESS:HOST_PORT/api	No	The address where all microservices are to be orchestrated. A /api must be appended.
OPEN_API_ENDPOINTS	'[]'	No	An Array of Open APi Specifications which then will be merged to one big specification

3.1 npm run dev for development with nodemon 3.2 npm start for deployment

1. Subsequently, the Swagger UI of the Open-API specification should be accessible at the following address. It is an aggregated Open-API of all the microservices. If a specific microservice needs to be tested, the mask must be adjusted to point to the respective host and port:

http://localhost:PORT/api

To access the API endpoints detailed in the Open-API specification, an API token is required. This token is generated during the initialization of the clm-core module. Please refer to the .env table

Swagger Documentation

• A Swagger UI is presented at the specified DEPLOY_URL. This UI displays all REST interfaces in Open API 3.0 format that are offered through the Open Core.

Changelog

The changelog can be found in the CHANGELOG.md file.

Get in touch with a developer

Please see the file AUTHORS.md to get in touch with the authors of this project. We will be happy to answer your questions at {[email protected]}

License

The project is made available under the license in the file license.txt