feat: add new /api/v1 prefix to all routes

README.md

@@ -38,8 +38,9 @@
   - [2.2. Setting up environment variables (optional)](#22-setting-up-environment-variables-optional)
   - [2.3. Running locally](#23-running-locally)
 * [3. Appendix](#-3-appendix)
-  - [3.1. Useful commands](#31-useful-commands)
-  - [3.2. Docker Compose service directory](#32-docker-compose-service-directory)
+  - [3.1. Documentation](#31-documentation)
+  - [3.2. Useful commands](#32-useful-commands)
+  - [3.3. Docker Compose service directory](#33-docker-compose-service-directory)
 * [4. How To Contribute](#-4-how-to-contribute)
 * [5. License](#-5-license)
 
@@ -85,13 +86,19 @@ yarn start
 
 > ⚠️ **NOTE:** The `yarn start` command will run/re-run the setup script, but will not overwrite the file `.env` that was created and edited in section [1.2.](#22-setting-up-environment-variables-optional)
 
-2. Navigate to [http://localhost:3000/versions](http://localhost:3000/versions) to make sure everything is runnning.
+2. Navigate to [http://localhost:3000/api/v1/versions](http://localhost:3000/api/v1/versions) to make sure everything is running.
 
 <sup>[Back to top ^][table-of-contents]</sup>
 
 ## 📑 3. Appendix
 
-### 3.1. Useful commands
+### 3.1. Documentation
+
+The API comes with some OpenAPI documentation. This can be accessed at [http://localhost:3000/api](http://localhost:3000/api).
+
+This documentation outlines the available endpoints available.
+
+### 3.2. Useful commands
 
 | Command           | Description                                                                                                                              |
 |-------------------|------------------------------------------------------------------------------------------------------------------------------------------|
@@ -100,7 +107,7 @@ yarn start
 
 <sup>[Back to top ^][table-of-contents]</sup>
 
-### 3.2. Docker Compose service directory
+### 3.3. Docker Compose service directory
 
 Here is a list of all the localhost port mappings for each of the apps
 

src/enums/APIPathEnum.ts

@@ -1,6 +1,6 @@
 enum APIPathEnum {
+  API = 'api',
   Chains = 'chains',
-  Docs = 'docs',
   Fees = 'fees',
   Versions = 'versions',
 }

src/main.ts

@@ -15,11 +15,13 @@ import type { IEnvironmentVariables, ILogLevel } from '@app/types';
 
 // utils
 import createLoggerService from '@app/utils/createLoggerService';
+import parseVersion from '@app/utils/parseVersion';
 
 (async () => {
   let app: NestApplication;
   let configService: ConfigService<IEnvironmentVariables, true>;
   let logger: LoggerService;
+  let versions: string[];
 
   try {
     app = await NestFactory.create(AppModule);
@@ -28,6 +30,9 @@ import createLoggerService from '@app/utils/createLoggerService';
       configService.get<string>(EnvironmentVariableKeyEnum.AppName),
       configService.get<ILogLevel>(EnvironmentVariableKeyEnum.LogLevel)
     );
+    versions = parseVersion(
+      configService.get<string>(EnvironmentVariableKeyEnum.AppVersion)
+    );
 
     // setup middleware
     app.useLogger(logger);
@@ -40,11 +45,12 @@ import createLoggerService from '@app/utils/createLoggerService';
         },
       })
     );
+    app.setGlobalPrefix(`${APIPathEnum.API}/v${versions[0]}`);
     app.useGlobalPipes(new ValidationPipe()); // for validating query params
 
     // setup open api
     SwaggerModule.setup(
-      APIPathEnum.Docs,
+      APIPathEnum.API,
       app,
       SwaggerModule.createDocument(
         app,

src/modules/versions/dtos/DatabaseConnectionResponseBodyDTO.ts

@@ -16,6 +16,8 @@ export default class DatabaseConnectionResponseBodyDTO {
   public readonly status: ConnectionStatusEnum;
   @ApiProperty({
     description: 'The type of database.',
+    enum: ConnectionStatusEnum,
+    enumName: 'ConnectionStatusEnum',
   })
   public readonly type: string;
   @ApiProperty({

src/modules/versions/dtos/VersionResponseBodyDTO.ts

@@ -13,6 +13,7 @@ interface IProps {
 export default class VersionResponseBodyDTO {
   @ApiProperty({
     description: 'Database connection information.',
+    type: DatabaseConnectionResponseBodyDTO,
   })
   public readonly databases: DatabaseConnectionResponseBodyDTO[];
   @ApiProperty({

src/utils/parseVersion/index.ts

@@ -0,0 +1 @@
+export { default } from './parseVersion';

src/utils/parseVersion/parseVersion.ts

@@ -0,0 +1,5 @@
+export default function parseVersion(version: string): string[] {
+  const sanitizedVersion: string = version.replace(/[^\d.]/g, '');
+
+  return sanitizedVersion.split('.');
+}