mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-29 02:14:24 -05:00
2225057ebe
This makes the Swagger UI route more consistent to the real API routes. Especially, the "private" prefix of the private API docs was irritating. Additionally, this commit adds a rule to the Caddyfile for proxying the API docs to the backend. Signed-off-by: Erik Michelson <github@erik.michelson.eu>
86 lines
2.5 KiB
TypeScript
86 lines
2.5 KiB
TypeScript
/*
|
|
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
|
|
*
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
import { HttpAdapterHost } from '@nestjs/core';
|
|
import { NestExpressApplication } from '@nestjs/platform-express';
|
|
import { WsAdapter } from '@nestjs/platform-ws';
|
|
|
|
import { AppConfig } from './config/app.config';
|
|
import { AuthConfig } from './config/auth.config';
|
|
import { MediaConfig } from './config/media.config';
|
|
import { ErrorExceptionMapping } from './errors/error-mapping';
|
|
import { ConsoleLoggerService } from './logger/console-logger.service';
|
|
import { BackendType } from './media/backends/backend-type.enum';
|
|
import { SessionService } from './session/session.service';
|
|
import { setupSpecialGroups } from './utils/createSpecialGroups';
|
|
import { setupSessionMiddleware } from './utils/session';
|
|
import { setupValidationPipe } from './utils/setup-pipes';
|
|
import { setupPrivateApiDocs, setupPublicApiDocs } from './utils/swagger';
|
|
|
|
/**
|
|
* Common setup function which is called by main.ts and the E2E tests.
|
|
*/
|
|
export async function setupApp(
|
|
app: NestExpressApplication,
|
|
appConfig: AppConfig,
|
|
authConfig: AuthConfig,
|
|
mediaConfig: MediaConfig,
|
|
logger: ConsoleLoggerService,
|
|
): Promise<void> {
|
|
await setupPublicApiDocs(app);
|
|
logger.log(
|
|
`Serving OpenAPI docs for public API under '/apidoc/v2'`,
|
|
'AppBootstrap',
|
|
);
|
|
|
|
if (process.env.NODE_ENV === 'development') {
|
|
await setupPrivateApiDocs(app);
|
|
logger.log(
|
|
`Serving OpenAPI docs for private API under '/apidoc/private'`,
|
|
'AppBootstrap',
|
|
);
|
|
}
|
|
|
|
await setupSpecialGroups(app);
|
|
|
|
setupSessionMiddleware(
|
|
app,
|
|
authConfig,
|
|
app.get(SessionService).getTypeormStore(),
|
|
);
|
|
|
|
app.enableCors({
|
|
origin: appConfig.rendererBaseUrl,
|
|
});
|
|
logger.log(
|
|
`Enabling CORS for '${appConfig.rendererBaseUrl}'`,
|
|
'AppBootstrap',
|
|
);
|
|
|
|
app.useGlobalPipes(setupValidationPipe(logger));
|
|
|
|
if (mediaConfig.backend.use === BackendType.FILESYSTEM) {
|
|
logger.log(
|
|
`Serving the local folder '${mediaConfig.backend.filesystem.uploadPath}' under '/uploads'`,
|
|
'AppBootstrap',
|
|
);
|
|
app.useStaticAssets(mediaConfig.backend.filesystem.uploadPath, {
|
|
prefix: '/uploads/',
|
|
});
|
|
}
|
|
|
|
logger.log(
|
|
`Serving the local folder 'public' under '/public'`,
|
|
'AppBootstrap',
|
|
);
|
|
app.useStaticAssets('public', {
|
|
prefix: '/public/',
|
|
});
|
|
|
|
const { httpAdapter } = app.get(HttpAdapterHost);
|
|
app.useGlobalFilters(new ErrorExceptionMapping(httpAdapter));
|
|
app.useWebSocketAdapter(new WsAdapter(app));
|
|
app.enableShutdownHooks();
|
|
}
|