backstage-grpc-playground
Advanced tools
A frontend plugin for Backstage supporting gRPC playground
backstage-grpc-playground is a backstage plugin ported from BloomRPC which is an Electron application. We modified some of the original code to make this compatible with Backstage entity. See Compare to BloomRPC
This repo contains React frontend plugin. For the backend plugin, please checkout backstage-grpc-playground-backend
View Full changelog
We are currently not supporting
Install backstage-grpc-playground for packages/app
E.g: In your backstage project root
yarn --cwd packages/app add backstage-grpc-playground
grpc type// packages/app/src/apis.ts
import { GrpcPlaygroundComponent } from 'backstage-grpc-playground';
// your code
// ...
export const apis: AnyApiFactory[] = [
// other apis
// ...
createApiFactory({
api: apiDocsConfigRef,
deps: {},
factory: () => {
// load the default widgets
const definitionWidgets = defaultDefinitionWidgets();
return {
getApiDefinitionWidget: (apiEntity: ApiEntity) => {
// custom rendering for grpc
if (apiEntity.spec.type === 'grpc') {
return {
type: 'grpc',
title: 'gRPC Playground',
component: GrpcPlaygroundComponent
}
}
// fallback to the defaults
return definitionWidgets.find(d => d.type === apiEntity.spec.type);
},
};
},
}),
]
/grpc-playground in backstage application// packages/app/src/App.tsx
import { GrpcPlaygroundPage } from 'backstage-grpc-playground'
// your code
// ...
const routes = (
<FlatRoutes>
// other routes
// ...
<Route path="/grpc-playground" element={<GrpcPlaygroundPage />} />
</FlatRoutes>
);
Example importing API definition from Github examples/yaml-definition/unary.yaml
User upload a file "employee.proto" that imports "common.proto"
User upload a file "account.proto" that imports some google-apis proto files. In this case user should import google folder
See yaml-definition
See example
See example
See example
FAQs
A frontend plugin for Backstage supporting gRPC playground
The npm package backstage-grpc-playground receives a total of 314 weekly downloads. As such, backstage-grpc-playground popularity was classified as not popular.
We found that backstage-grpc-playground demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.Ā It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious PyPI checkers validate stolen emails against TikTok and Instagram APIs, enabling targeted account attacks and dark web credential sales.
Security News
The Node.js TSC opted not to endorse a feature bounty program, citing concerns about incentives, governance, and project neutrality.
Research
Security News
A look at the top trends in how threat actors are weaponizing open source packages to deliver malware and persist across the software supply chain.