Welcome to the DevTools backend plugin! This plugin provides data for the DevTools frontend features.
Here's how to get the DevTools Backend up and running:
-
First we need to add the
@backstage/plugin-devtools-backendpackage to your backend:# From the Backstage root directory yarn add --cwd packages/backend @backstage/plugin-devtools-backend -
Then we will create a new file named
packages/backend/src/plugins/devtools.ts, and add the following to it:import { createRouter } from '@backstage/plugin-devtools-backend'; import { Router } from 'express'; import type { PluginEnvironment } from '../types'; export default function createPlugin( env: PluginEnvironment, ): Promise<Router> { return createRouter({ logger: env.logger, config: env.config, permissions: env.permissions, }); }
-
Next we wire this into the overall backend router, edit
packages/backend/src/index.ts:import devTools from './plugins/devtools'; // ... async function main() { // ... // Add this line under the other lines that follow the useHotMemoize pattern const devToolsEnv = useHotMemoize(module, () => createEnv('devtools')); // ... // Insert this line under the other lines that add their routers to apiRouter in the same way apiRouter.use('/devtools', await devTools(devToolsEnv));
-
Now run
yarn start-backendfrom the repo root -
Finally open
http://localhost:7007/api/devtools/healthin a browser and it should return{"status":"ok"}