Skip to content

Commit 05e0b8c

Browse files
author
hirsch88
committed
Fix swagger route
1 parent 65fc936 commit 05e0b8c

File tree

6 files changed

+19
-14
lines changed

6 files changed

+19
-14
lines changed

.env.example

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
# APPLICATION
33
#
44
APP_NAME="express-typescript-boilerplate"
5-
APP_ROUTE="http://localhost:3000"
5+
APP_SCHEMA="http"
6+
APP_HOST="localhost"
7+
APP_PORT="3000"
68
APP_ROUTE_PREFIX="/api"
79
APP_BANNER=true
810

.env.test

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
# APPLICATION
33
#
44
APP_NAME="express-typescript-boilerplate"
5-
APP_ROUTE="http://localhost:3000"
5+
APP_SCHEMA="http"
6+
APP_HOST="localhost"
7+
APP_PORT="3000"
68
APP_ROUTE_PREFIX="/api"
79
APP_BANNER=false
810

src/api/swagger.json

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@
1313
"produces": [
1414
"application/json"
1515
],
16-
"schemes": [
17-
"http"
18-
],
16+
"schemes": [],
1917
"securityDefinitions": {
2018
"JWT": {
2119
"type": "apiKey",
@@ -35,7 +33,7 @@
3533
}
3634
],
3735
"paths": {
38-
"/info": {
36+
"/": {
3937
"get": {
4038
"tags": [
4139
"Info"

src/env.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ export const env = {
2121
name: getOsEnv('APP_NAME'),
2222
version: (pkg as any).version,
2323
description: (pkg as any).description,
24-
route: getOsEnv('APP_ROUTE'),
24+
host: getOsEnv('APP_HOST'),
25+
schema: getOsEnv('APP_SCHEMA'),
2526
routePrefix: getOsEnv('APP_ROUTE_PREFIX'),
26-
port: normalizePort(process.env.PORT || '3000'),
27+
port: normalizePort(process.env.PORT || getOsEnv('APP_PORT')),
2728
banner: toBool(getOsEnv('APP_BANNER')),
2829
dirs: {
2930
migrations: [path.relative(path.join(process.cwd()), path.join(__dirname, 'database/migrations/*.ts'))],

src/lib/banner.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,24 @@ import { Logger } from '../lib/logger';
33

44
export function banner(log: Logger): void {
55
if (env.app.banner) {
6+
const route = () => `${env.app.schema}://${env.app.host}:${env.app.port}`;
67
log.info(``);
7-
log.info(`Aloha, your app is ready on ${env.app.route}${env.app.routePrefix}`);
8+
log.info(`Aloha, your app is ready on ${route()}${env.app.routePrefix}`);
89
log.info(`To shut it down, press <CTRL> + C at any time.`);
910
log.info(``);
1011
log.info('-------------------------------------------------------');
1112
log.info(`Environment : ${env.node}`);
1213
log.info(`Version : ${env.app.version}`);
1314
log.info(``);
14-
log.info(`API Info : ${env.app.route}${env.app.routePrefix}`);
15+
log.info(`API Info : ${route()}${env.app.routePrefix}`);
1516
if (env.graphql.enabled) {
16-
log.info(`GraphQL : ${env.app.route}${env.graphql.route}`);
17+
log.info(`GraphQL : ${route()}${env.graphql.route}`);
1718
}
1819
if (env.swagger.enabled) {
19-
log.info(`Swagger : ${env.app.route}${env.swagger.route}`);
20+
log.info(`Swagger : ${route()}${env.swagger.route}`);
2021
}
2122
if (env.monitor.enabled) {
22-
log.info(`Monitor : ${env.app.route}${env.monitor.route}`);
23+
log.info(`Monitor : ${route()}${env.monitor.route}`);
2324
}
2425
log.info('-------------------------------------------------------');
2526
log.info('');

src/loaders/swaggerLoader.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ export const swaggerLoader: MicroframeworkLoader = (settings: MicroframeworkSett
1616
description: env.app.description,
1717
version: env.app.version,
1818
};
19-
swaggerFile.host = env.app.route;
19+
swaggerFile.host = `${env.app.host}:${env.app.port}`;
2020
swaggerFile.basePath = env.app.routePrefix;
21+
swaggerFile.schemes = [env.app.schema];
2122

2223
expressApp.use(
2324
env.swagger.route,

0 commit comments

Comments
 (0)