Registry / devops / backstage-grpc-playground-backend-new

backstage-grpc-playground-backend-new

library0.5.3jsnpmunverified

Backend plugin for Backstage that provides a gRPC playground UI, inspired by BloomRPC. Version 0.5.3 is the latest stable release, with monthly releases on average. It integrates with Backstage's database, reader, and logger, and is designed for use with the frontend plugin backstage-grpc-playground. Differentiator: brings gRPC exploration directly into Backstage, eliminating the need for external tools like BloomRPC.

devops

npm install backstage-grpc-playground-backend-new

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · BACKSTAGE-GRPC-PLA

backstage-grpc-playground-backend-new

devopsjavascriptv0.5.3

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

createRouter

✓ import { createRouter } from 'backstage-grpc-playground-backend'

✗ import createRouter from 'backstage-grpc-playground-backend'

Named export only, no default export. TypeScript types included.

createPlugin

✓ export default async function createPlugin(env: PluginEnvironment): Promise<Router>

✗ module.exports = createPlugin

ESM-style export required for Backstage plugin pattern.

PluginEnvironment

✓ import { PluginEnvironment } from '../types'

✗ import { PluginEnvironment } from 'backstage-grpc-playground-backend'

PluginEnvironment is a Backstage type, not exported by this package.

Registers the gRPC playground backend plugin in a Backstage backend, creating a router.

// packages/backend/src/plugins/grpc-playground.ts import { ScmIntegrations } from '@backstage/integration'; import { createRouter } from 'backstage-grpc-playground-backend'; import { Router } from 'express'; import { PluginEnvironment } from '../types'; export default async function createPlugin( env: PluginEnvironment, ): Promise<Router> { const { config, reader } = env; const integrations = ScmIntegrations.fromConfig(config); return await createRouter({ logger: env.logger, reader, integrations, database: env.database, }); }

Debug

Known issues

gotchaRequires @backstage/integration to be installed separately

fix

Run 'yarn --cwd packages/backend add @backstage/integration'.

affects: >=0.0.0

gotchaPluginEnvironment type must be defined locally, not exported by this package

fix

Define PluginEnvironment type in your backend's types file, typically packages/backend/src/types.ts.

affects: >=0.0.0

gotchaDatabase dependency: env.database must provide a backend DatabaseManager instance

fix

Ensure your createEnv function provides a database property from @backstage/backend-common's DatabaseManager.

affects: >=0.0.0

Errors

Common errors & fixes

Error: Cannot find module 'backstage-grpc-playground-backend'

Package not installed in packages/backend

fix

yarn --cwd packages/backend add backstage-grpc-playground-backend

TypeError: createRouter is not a function

Default import used instead of named import

fix

import { createRouter } from 'backstage-grpc-playground-backend'

Property 'database' does not exist on type 'PluginEnvironment'

PluginEnvironment type missing database property

fix

Add 'database: any;' to your PluginEnvironment interface or type definition.

Upgrade

Version history

0.5.3latest on npm

Audit

Dependencies

@backstage/integrationrequiredUses ScmIntegrations for config-based integrations

Agent activity

8 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/zalopay-oss/backstage-grpc-playground-backend ↗

packagebackstage-grpc-playground-backend-new ↗

homepagehttps://github.com/zalopay-oss/backstage-grpc-playground-backend ↗