From 02d7958ea48b6125c7f0c80a0ba052a965121a0e Mon Sep 17 00:00:00 2001 From: ricardo Date: Tue, 26 Apr 2022 16:20:35 -0400 Subject: [PATCH] :zap: Expose swagger ui in GET /{version}/docs --- packages/cli/package.json | 8 +++++-- packages/cli/src/PublicApi/index.ts | 24 +++++++++++++++---- packages/cli/src/PublicApi/swaggerTheme.css | 26 +++++++++++++++++++++ packages/cli/src/PublicApi/v1/openapi.yml | 18 ++++++-------- 4 files changed, 59 insertions(+), 17 deletions(-) create mode 100644 packages/cli/src/PublicApi/swaggerTheme.css diff --git a/packages/cli/package.json b/packages/cli/package.json index 30774e0e95..fae3a33ab9 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -19,7 +19,7 @@ "bin": "n8n" }, "scripts": { - "build": "tsc && cp -r ./src/UserManagement/email/templates ./dist/src/UserManagement/email; rsync -a --include='*/' --include='*.yml' --exclude='*' ./src/PublicApi/ ./dist/src/PublicApi/", + "build": "tsc && cp -r ./src/UserManagement/email/templates ./dist/src/UserManagement/email; rsync -a --include='*/' --include={'*.yml','*.css'} --exclude='*' ./src/PublicApi/ ./dist/src/PublicApi/", "dev": "concurrently -k -n \"TypeScript,Node\" -c \"yellow.bold,cyan.bold\" \"npm run watch\" \"nodemon\"", "format": "cd ../.. && node_modules/prettier/bin-prettier.js packages/cli/**/**.ts --write", "lint": "cd ../.. && node_modules/eslint/bin/eslint.js packages/cli", @@ -97,6 +97,8 @@ "@rudderstack/rudder-sdk-node": "1.0.6", "@types/json-diff": "^0.5.1", "@types/jsonwebtoken": "^8.5.2", + "@types/swagger-ui-express": "^4.1.3", + "@types/yamljs": "^0.2.31", "basic-auth": "^2.0.1", "bcryptjs": "^2.4.3", "body-parser": "^1.18.3", @@ -143,10 +145,12 @@ "request-promise-native": "^1.0.7", "sqlite3": "^5.0.2", "sse-channel": "^3.1.1", + "swagger-ui-express": "^4.3.0", "tslib": "1.14.1", "typeorm": "0.2.30", "uuid": "^8.3.0", "validator": "13.7.0", - "winston": "^3.3.3" + "winston": "^3.3.3", + "yamljs": "^0.3.0" } } diff --git a/packages/cli/src/PublicApi/index.ts b/packages/cli/src/PublicApi/index.ts index 32e96028b9..1ea0225a8f 100644 --- a/packages/cli/src/PublicApi/index.ts +++ b/packages/cli/src/PublicApi/index.ts @@ -8,15 +8,29 @@ import * as OpenApiValidator from 'express-openapi-validator'; import { HttpError } from 'express-openapi-validator/dist/framework/types'; import fs from 'fs/promises'; import path from 'path'; +import * as swaggerUi from 'swagger-ui-express'; +import * as YAML from 'yamljs'; +import config from '../../config'; import { authenticationHandler, specFormats } from './helpers'; function createApiRouter( version: string, openApiSpecPath: string, hanldersDirectory: string, + swaggerThemeCss: string, ): Router { + const n8nPath = config.getEnv('path'); + const swaggerDocument = YAML.load(openApiSpecPath) as swaggerUi.JsonObject; const apiController = express.Router(); - apiController.use(`/${version}/spec`, express.static(openApiSpecPath)); + apiController.use( + `/${version}/docs`, + swaggerUi.serveFiles(swaggerDocument), + swaggerUi.setup(swaggerDocument, { + customCss: swaggerThemeCss, + customSiteTitle: 'n8n Public API UI', + customfavIcon: `${n8nPath}favicon.ico`, + }), + ); apiController.use(`/${version}`, express.json()); apiController.use( `/${version}`, @@ -44,12 +58,14 @@ function createApiRouter( } export const loadPublicApiVersions = async (): Promise => { - const data = await fs.readdir(__dirname); - const versions = data.filter((folderName) => folderName.startsWith('v')); + const swaggerThemePath = path.join(__dirname, 'swaggerTheme.css'); + const folders = await fs.readdir(__dirname); + const css = (await fs.readFile(swaggerThemePath)).toString(); + const versions = folders.filter((folderName) => folderName.startsWith('v')); const apiRouters: express.Router[] = []; for (const version of versions) { const openApiPath = path.join(__dirname, version, 'openapi.yml'); - apiRouters.push(createApiRouter(version, openApiPath, __dirname)); + apiRouters.push(createApiRouter(version, openApiPath, __dirname, css)); } return apiRouters; }; diff --git a/packages/cli/src/PublicApi/swaggerTheme.css b/packages/cli/src/PublicApi/swaggerTheme.css new file mode 100644 index 0000000000..b7682cc8fa --- /dev/null +++ b/packages/cli/src/PublicApi/swaggerTheme.css @@ -0,0 +1,26 @@ +.swagger-ui .info .title small:last-child { + background-color: #ff6d5a !important +} + +.swagger-ui .topbar { + background-color: #fff; +} + +.swagger-ui img { + content: url(data:image/svg+xml;base64,<svg width="124" height="28" viewBox="0 0 124 28" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" data-v-78c27a9a=""><title data-v-78c27a9a="">n8</title> <g id="nav-menu-(V1)" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd" data-v-78c27a9a=""><g id="nav-menu-(v1)" transform="translate(-120.000000, -116.000000)" fill-rule="nonzero" data-v-78c27a9a="" fill="none"><g id="n8" transform="translate(120.000000, 116.000000)" data-v-78c27a9a="" fill="none"><path d="M48.7384906,0.190188679 C46.1577358,0.190188679 43.9864151,1.96792453 43.3735849,4.36113208 L35.6524528,4.36113208 C32.6226415,4.36113208 30.1581132,6.82566038 30.1581132,9.8554717 C30.1581132,11.3690566 28.9271698,12.6026415 27.4109434,12.6026415 L26.309434,12.6026415 C25.6966038,10.209434 23.5279245,8.43169811 20.9445283,8.43169811 C18.3637736,8.43169811 16.1924528,10.209434 15.5796226,12.6026415 L11.1683019,12.6026415 C10.5554717,10.209434 8.38679245,8.43169811 5.80339623,8.43169811 C2.74716981,8.43169811 0.258867925,10.9173585 0.258867925,13.9762264 C0.258867925,17.0324528 2.7445283,19.5207547 5.80339623,19.5207547 C8.38415094,19.5207547 10.5554717,17.7430189 11.1683019,15.3498113 L15.5849057,15.3498113 C16.1977358,17.7430189 18.3664151,19.5207547 20.9498113,19.5207547 C23.514717,19.5207547 25.6701887,17.769434 26.3015094,15.4 L27.4135849,15.4 C28.9271698,15.4 30.1607547,16.6309434 30.1607547,18.1471698 C30.1607547,21.1769811 32.625283,23.6415094 35.6550943,23.6415094 L37.4539623,23.6415094 C38.0667925,26.034717 40.2354717,27.8124528 42.8188679,27.8124528 C45.8750943,27.8124528 48.3633962,25.3267925 48.3633962,22.2679245 C48.3633962,19.2116981 45.8777358,16.7233962 42.8188679,16.7233962 C40.2381132,16.7233962 38.0667925,18.5011321 37.4539623,20.8943396 L35.6550943,20.8943396 C34.1415094,20.8943396 32.9079245,19.6633962 32.9079245,18.1471698 C32.9079245,16.4935849 32.1683019,15.0090566 31.0086792,14.0026415 C32.1709434,12.9935849 32.9079245,11.5116981 32.9079245,9.85811321 C32.9079245,8.3445283 34.1388679,7.1109434 35.6550943,7.1109434 L43.3762264,7.1109434 C43.9890566,9.50415094 46.1577358,11.2818868 48.7411321,11.2818868 C51.7973585,11.2818868 54.2856604,8.79622642 54.2856604,5.73735849 C54.2830189,2.67849057 51.794717,0.190188679 48.7384906,0.190188679 Z M5.80867925,16.7709434 C4.26603774,16.7709434 3.01132075,15.5162264 3.01132075,13.9735849 C3.01132075,12.4309434 4.26603774,11.1762264 5.80867925,11.1762264 C7.35132075,11.1762264 8.60603774,12.4309434 8.60603774,13.9735849 C8.60603774,15.5162264 7.35132075,16.7709434 5.80867925,16.7709434 Z M20.9498113,16.7709434 C19.4071698,16.7709434 18.1524528,15.5162264 18.1524528,13.9735849 C18.1524528,12.4309434 19.4071698,11.1762264 20.9498113,11.1762264 C22.4924528,11.1762264 23.7471698,12.4309434 23.7471698,13.9735849 C23.7471698,15.5162264 22.4924528,16.7709434 20.9498113,16.7709434 Z M42.8162264,19.4679245 C44.3588679,19.4679245 45.6135849,20.7226415 45.6135849,22.265283 C45.6135849,23.8079245 44.3588679,25.0626415 42.8162264,25.0626415 C41.2735849,25.0626415 40.0188679,23.8079245 40.0188679,22.265283 C40.0215094,20.7226415 41.2762264,19.4679245 42.8162264,19.4679245 Z M48.7384906,8.53207547 C47.1958491,8.53207547 45.9411321,7.27735849 45.9411321,5.73471698 C45.9411321,4.19207547 47.1958491,2.93735849 48.7384906,2.93735849 C50.2811321,2.93735849 51.5358491,4.19207547 51.5358491,5.73471698 C51.5358491,7.27735849 50.2811321,8.53207547 48.7384906,8.53207547 Z" id="Shape" fill="#FF6D5A" data-v-78c27a9a=""></path> <g id="Group" transform="translate(56.528302, 5.547170)" fill="#384D5B" data-v-78c27a9a=""><path d="M1.57962264,7.09773585 C1.57962264,6.76490566 1.40264151,6.6090566 1.0909434,6.6090566 L0.179622642,6.6090566 L0.179622642,4.76528302 L2.24792453,4.76528302 C3.20415094,4.76528302 3.67169811,5.18792453 3.67169811,6.00943396 L3.67169811,6.43207547 C3.67169811,6.78867925 3.62679245,7.07660377 3.62679245,7.07660377 L3.67169811,7.07660377 C4.1154717,6.09924528 5.44943396,4.49849057 7.8954717,4.49849057 C10.5633962,4.49849057 11.7626415,5.94339623 11.7626415,8.80943396 L11.7626415,13.6777358 C11.7626415,14.010566 11.9396226,14.1664151 12.2513208,14.1664151 L13.1626415,14.1664151 L13.1626415,16.0101887 L11.0283019,16.0101887 C10.0271698,16.0101887 9.6045283,15.5875472 9.6045283,14.5864151 L9.6045283,9.29811321 C9.6045283,7.71849057 9.29283019,6.47433962 7.49396226,6.47433962 C5.76113208,6.47433962 4.38226415,7.60754717 3.93849057,9.23207547 C3.78264151,9.67584906 3.73773585,10.1883019 3.73773585,10.7430189 L3.73773585,16.0101887 L1.58226415,16.0101887 L1.58226415,7.09773585 L1.57962264,7.09773585 Z" id="Path" data-v-78c27a9a="" fill="#384D5B"></path> <path d="M17.6690566,7.49660377 L17.6690566,7.45169811 C17.6690566,7.45169811 15.7354717,6.42943396 15.7354717,4.25018868 C15.7354717,2.0709434 17.4683019,0.0501886792 20.6249057,0.0501886792 C23.6256604,0.0501886792 25.5381132,1.85169811 25.5381132,4.29509434 C25.5381132,6.60641509 23.649434,8.03018868 23.649434,8.03018868 L23.649434,8.07509434 C25.0732075,8.89660377 25.9845283,9.98754717 25.9845283,11.6754717 C25.9845283,14.1215094 23.7630189,16.2769811 20.5615094,16.2769811 C17.6056604,16.2769811 15.0935829,14.4332075 15.0935829,11.5196226 C15.0909434,8.94150943 17.6690566,7.49660377 17.6690566,7.49660377 Z M20.5588679,14.2535849 C22.2045283,14.2535849 23.7366038,13.165283 23.7366038,11.609434 C23.7366038,10.230566 22.5584906,9.6309434 21.0924528,9.03132075 C20.4928302,8.78566038 19.6475472,8.45283019 19.470566,8.45283019 C18.9158491,8.45283019 17.3362264,9.74188679 17.3362264,11.4086792 C17.3362264,13.165283 18.8471698,14.2535849 20.5588679,14.2535849 Z M21.7158491,7.14 C22.249434,7.14 23.3826415,5.82716981 23.3826415,4.42716981 C23.3826415,2.98226415 22.2256604,2.0709434 20.6275472,2.0709434 C18.9158491,2.0709434 17.914717,3.04830189 17.914717,4.29245283 C17.914717,5.67132075 19.0928302,6.20490566 20.4928302,6.75962264 C20.8045283,6.89698113 21.4490566,7.14 21.7158491,7.14 Z" id="Shape" data-v-78c27a9a="" fill="#384D5B"></path> <path d="M29.405283,7.09773585 C29.405283,6.76490566 29.2283019,6.6090566 28.9166038,6.6090566 L28.005283,6.6090566 L28.005283,4.76528302 L30.0735849,4.76528302 C31.0298113,4.76528302 31.4973585,5.18792453 31.4973585,6.00943396 L31.4973585,6.43207547 C31.4973585,6.78867925 31.4524528,7.07660377 31.4524528,7.07660377 L31.4973585,7.07660377 C31.9411321,6.09924528 33.2750943,4.49849057 35.7211321,4.49849057 C38.3890566,4.49849057 39.5883019,5.94339623 39.5883019,8.80943396 L39.5883019,13.6777358 C39.5883019,14.010566 39.765283,14.1664151 40.0769811,14.1664151 L40.9883019,14.1664151 L40.9883019,16.0101887 L38.8539623,16.0101887 C37.8528302,16.0101887 37.4301887,15.5875472 37.4301887,14.5864151 L37.4301887,9.29811321 C37.4301887,7.71849057 37.1184906,6.47433962 35.3196226,6.47433962 C33.5867925,6.47433962 32.2079245,7.60754717 31.7641509,9.23207547 C31.6083019,9.67584906 31.5633962,10.1883019 31.5633962,10.7430189 L31.5633962,16.0101887 L29.4079245,16.0101887 L29.4079245,7.09773585 L29.405283,7.09773585 Z" id="Path" data-v-78c27a9a="" fill="#384D5B"></path> <polygon id="Path" points="43.54 13.72 45.7403774 13.72 45.7403774 16.0101887 43.54 16.0101887" data-v-78c27a9a="" fill="#384D5B"></polygon> <path d="M48.7173585,7.09773585 C48.7173585,6.76490566 48.5403774,6.6090566 48.2286792,6.6090566 L47.3173585,6.6090566 L47.3173585,4.76528302 L49.4279245,4.76528302 C50.4290566,4.76528302 50.8516981,5.18792453 50.8516981,6.1890566 L50.8516981,13.6803774 C50.8516981,14.0132075 51.0286792,14.1690566 51.3403774,14.1690566 L52.2516981,14.1690566 L52.2516981,16.0128302 L50.1411321,16.0128302 C49.14,16.0128302 48.7173585,15.5901887 48.7173585,14.5890566 L48.7173585,7.09773585 Z" id="Path" data-v-78c27a9a="" fill="#384D5B"></path> <path d="M60.2316981,4.49584906 C63.5890566,4.49584906 66.2992453,6.96301887 66.2992453,10.365283 C66.2992453,13.7886792 63.5864151,16.2769811 60.2316981,16.2769811 C56.8743396,16.2769811 54.185283,13.7860377 54.185283,10.365283 C54.185283,6.96301887 56.8743396,4.49584906 60.2316981,4.49584906 Z M60.2316981,14.409434 C62.3660377,14.409434 64.0988679,12.7188679 64.0988679,10.3626415 C64.0988679,8.02754717 62.3660377,6.36075472 60.2316981,6.36075472 C58.1211321,6.36075472 56.3856604,8.02754717 56.3856604,10.3626415 C56.3856604,12.7215094 58.1184906,14.409434 60.2316981,14.409434 Z" id="Shape" data-v-78c27a9a="" fill="#384D5B"></path></g> <path d="M106.230943,9.63886792 C105.124151,9.63886792 104.223396,8.73811321 104.223396,7.63132075 C104.223396,6.5245283 105.124151,5.62377358 106.230943,5.62377358 C107.337736,5.62377358 108.238491,6.5245283 108.238491,7.63132075 C108.238491,8.73811321 107.337736,9.63886792 106.230943,9.63886792 Z M106.230943,6.58792453 C105.657736,6.58792453 105.190189,7.0554717 105.190189,7.62867925 C105.190189,8.20188679 105.657736,8.66943396 106.230943,8.66943396 C106.804151,8.66943396 107.271698,8.20188679 107.271698,7.62867925 C107.271698,7.0554717 106.804151,6.58792453 106.230943,6.58792453 Z" id="Shape" fill="#FF6D5A" data-v-78c27a9a=""></path></g></g></g></svg>); + width: 140px; + height: 40px; +} + +.swagger-ui .btn.authorize { + border-color: #ff6d5a; + color: #3b4151; +} + +.swagger-ui .btn.authorize svg { + fill: #7d8492 +} + +.swagger-ui select { + border-color: #ff6d5a; +} diff --git a/packages/cli/src/PublicApi/v1/openapi.yml b/packages/cli/src/PublicApi/v1/openapi.yml index f71156f0df..d5053600ae 100644 --- a/packages/cli/src/PublicApi/v1/openapi.yml +++ b/packages/cli/src/PublicApi/v1/openapi.yml @@ -1,7 +1,7 @@ --- openapi: 3.0.0 info: - title: Public n8n API + title: n8n Public API description: n8n Public API termsOfService: https://n8n.io/legal/terms contact: @@ -9,26 +9,22 @@ info: license: name: Sustainable Use License url: https://github.com/n8n-io/n8n/blob/master/packages/cli/LICENSE.md - version: 1.0.0 + version: v1 externalDocs: description: n8n API documentation url: https://docs.n8n.io/api/ servers: - # Added by API Auto Mocking Plugin - url: /api/v1 tags: -- name: users +- name: User description: Operations about user - externalDocs: - description: Find out more about our store - url: http://swagger.io paths: /users: get: x-eov-operation-id: getUsers x-eov-operation-handler: v1/handlers/Users tags: - - users + - User summary: Retrieve all users description: Retrieve all users from your instance. Only available for the instance owner. parameters: @@ -74,7 +70,7 @@ paths: x-eov-operation-id: createUsers x-eov-operation-handler: v1/handlers/Users tags: - - users + - User summary: Invite a user description: Invites a user to your instance. Only available for the instance owner. operationId: createUser @@ -107,7 +103,7 @@ paths: x-eov-operation-id: getUser x-eov-operation-handler: v1/handlers/Users tags: - - users + - User summary: Get user by ID/Email description: Retrieve a user from your instance. Only available for the instance owner. operationId: getUser @@ -142,7 +138,7 @@ paths: x-eov-operation-id: deleteUser x-eov-operation-handler: v1/handlers/Users tags: - - users + - User summary: Delete user by ID/Email description: Deletes a user from your instance. Only available for the instance owner. operationId: deleteUser