feat: add OpenAPI support #34983
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| "@rocket.chat/meteor": minor | ||
| "@rocket.chat/rest-typings": minor | ||
| --- | ||
|
|
||
| feat: Adds OpenAPI support |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| import { isOpenAPIJSONEndpoint } from '@rocket.chat/rest-typings'; | ||
| import express from 'express'; | ||
| import { WebApp } from 'meteor/webapp'; | ||
| import swaggerUi from 'swagger-ui-express'; | ||
|
|
||
| import { settings } from '../../../settings/server'; | ||
| import { Info } from '../../../utils/rocketchat.info'; | ||
| import { API } from '../api'; | ||
| import type { Route } from '../router'; | ||
|
|
||
| const app = express(); | ||
|
There was a problem hiding this comment. import helmet from 'helmet';
import rateLimit from 'express-rate-limit';
const app = express();
app.use(helmet());
app.use(rateLimit({
windowMs: 60 * 1000, // 1 minute
max: 500 // higher limit for API docs
}));Lack of security measures such as input validation, origin checks, and security middleware, increasing the risk of security vulnerabilities. This issue appears in multiple locations:
Please add security measures such as input validation, origin checks, and security middleware to protect against potential security threats. Talk to Kody by mentioning @kody Was this suggestion helpful? React with 👍 or 👎 to help Kody learn from this interaction.
Comment on lines
+8
to
+11
There was a problem hiding this comment. const getTypedRoutes = (
typedRoutes: Record<string, Record<string, Route>>,
{ withUndocumented = false }: { withUndocumented?: boolean } = {},
): Record<string, Record<string, Route>> => {
if (!typedRoutes || typeof typedRoutes !== 'object') {
throw new Error('Invalid typedRoutes: Expected a non-null object with Route records');
}Add error handling for potential undefined or malformed Talk to Kody by mentioning @kody Was this suggestion helpful? React with 👍 or 👎 to help Kody learn from this interaction. |
||
|
|
||
| const getTypedRoutes = ( | ||
| typedRoutes: Record<string, Record<string, Route>>, | ||
| { withUndocumented = false }: { withUndocumented?: boolean } = {}, | ||
| ): Record<string, Record<string, Route>> => { | ||
| if (withUndocumented) { | ||
| return typedRoutes; | ||
| } | ||
|
|
||
| return Object.entries(typedRoutes).reduce( | ||
| (acc, [path, methods]) => { | ||
| const filteredMethods = Object.entries(methods) | ||
| .filter(([_, options]) => !options?.tags?.includes('Missing Documentation')) | ||
| .reduce( | ||
| (acc, [method, options]) => { | ||
| acc[method] = options; | ||
| return acc; | ||
| }, | ||
| {} as Record<string, Route>, | ||
| ); | ||
|
|
||
| if (Object.keys(filteredMethods).length > 0) { | ||
| acc[path] = filteredMethods; | ||
| } | ||
|
|
||
| return acc; | ||
| }, | ||
| {} as Record<string, Record<string, Route>>, | ||
| ); | ||
| }; | ||
|
|
||
| const makeOpenAPIResponse = (paths: Record<string, Record<string, Route>>) => ({ | ||
|
There was a problem hiding this comment. const BASE_OPENAPI_CONFIG = {
openapi: '3.0.3',
info: {
title: 'Rocket.Chat API',
description: 'Rocket.Chat API',
version: Info.version,
},
components: {
securitySchemes: {
userId: {
type: 'apiKey',
in: 'header',
name: 'X-User-Id',
},
authToken: {
type: 'apiKey',
in: 'header',
name: 'X-Auth-Token',
},
},
schemas: {},
},
};
const makeOpenAPIResponse = (paths: Record<string, Record<string, Route>>) => ({
...BASE_OPENAPI_CONFIG,
servers: [{ url: settings.get('Site_Url') }],
paths,
});Extract the OpenAPI configuration object into a separate constant to improve maintainability and reusability Talk to Kody by mentioning @kody Was this suggestion helpful? React with 👍 or 👎 to help Kody learn from this interaction. |
||
| openapi: '3.0.3', | ||
| info: { | ||
| title: 'Rocket.Chat API', | ||
| description: 'Rocket.Chat API', | ||
| version: Info.version, | ||
| }, | ||
| servers: [ | ||
| { | ||
| url: settings.get('Site_Url'), | ||
| }, | ||
| ], | ||
| components: { | ||
| securitySchemes: { | ||
| userId: { | ||
| type: 'apiKey', | ||
| in: 'header', | ||
| name: 'X-User-Id', | ||
| }, | ||
| authToken: { | ||
| type: 'apiKey', | ||
| in: 'header', | ||
| name: 'X-Auth-Token', | ||
| }, | ||
| }, | ||
| schemas: {}, | ||
| }, | ||
| paths, | ||
| }); | ||
|
|
||
| API.default.addRoute( | ||
| 'docs/json', | ||
| { authRequired: false, validateParams: isOpenAPIJSONEndpoint }, | ||
| { | ||
| get() { | ||
| const { withUndocumented = false } = this.queryParams; | ||
|
|
||
| return API.default.success(makeOpenAPIResponse(getTypedRoutes(API.v1.typedRoutes, { withUndocumented }))); | ||
| }, | ||
| }, | ||
| ); | ||
|
|
||
| app.use( | ||
MarcosSpessatto marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| '/api-docs', | ||
| swaggerUi.serve, | ||
| swaggerUi.setup(makeOpenAPIResponse(getTypedRoutes(API.v1.typedRoutes, { withUndocumented: false }))), | ||
| ); | ||
| WebApp.connectHandlers.use(app); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.