@postman-solutions/postman-backstage-backend-plugin

Postman Backend Plugin for Backstage

This postman-backend plugin provides some Postman services that will be used by the Postman frontend plugin to render the different component views.

Disclaimer

This plugin is not officially supported by Postman and is intended for Backstage users to integrate Postman into their API documentation easily.

Prerequisites

Before you begin, ensure you have the following:

• Make sure the Postman frontend is installed first
• A running instance of Backstage
• Node.js and npm installed (Node.js 18.x or later is recommended)
• Access to Postman API credentials

Configuration Guide

This guide provides instructions for configuring your application to interact with the Postman API using the app-config.yaml file. Follow the steps below to set up your environment correctly.

Basic Configuration

API Key Setup: First, include the base URL and set an environment variable POSTMAN_API_KEY with your Postman API key in the configuration file.

[!CAUTION] The apiKey in the configuration should not belong to an admin or super admin user, as this would grant access to all collections and APIs in the team. Instead, use an apiKey from a user with access only to the information that can be safely displayed to the authenticated developer audience in Backstage. This principle of least privilege helps to maintain tight control over your Postman data and reduces the potential impact if a user adds a reference to an entity in a private workspace or accidentally tags a private API with the tag used by the Postman entity provider.

    postman:
        baseUrl: https://api.postman.com
        apiKey: ${POSTMAN_API_KEY}

Advanced Configuration

1. Entity Provider Setup: The plugin includes an entity provider to fetch API assets from Postman periodically using a Postman tag. Tags can be added to collections or Postman APIs. To use this option, please add the following settings to your app-config.yaml:

   Parameter	Schema Type	Optional	Description
   postman/team	string	Yes	Name of your Postman team. For a team URL like https://myteam.postman.co, your team name would be myteam.postman.co.
   postman/owner	string	Yes	Owner of the API assets. The default is "postman". Consider creating a User or Group for this owner.
   postman/synchEntitiesWithTag	string	Yes	Postman tag used to fetch API assets.
   postman/entityProviderSynchInterval	string	Yes	Interval (in hours) for fetching the API assets from Postman.
   postman/system	string	Yes	System of the API assets. The default is "main".

   Example configuration:

  postman:
      baseUrl: https://api.postman.com
      apiKey: ${POSTMAN_API_KEY}
      team: my-team.postman.co
      synchEntitiesWithTag: backstage
      owner: postman-team
      entityProviderSynchInterval: 2
      system: my-system

2. Caching Options: The Postman backend plugin supports caching. Configure cache settings by adding the following properties:

   Parameter	Schema Type	Optional	Description
   postman/cache/ttl	number	Yes	Cache expiry time in milliseconds. The default is 600000 (10 minutes).

   Example configuration for a custom cache duration:

   postman:
       baseUrl: https://api.postman.com
       apiKey: ${POSTMAN_API_KEY}
       team: my-team.postman.co
       cache:
         ttl: 300000  # 5 minutes

If you prefer not to utilise caching and always get the latest information from Postman, you can set the TTL value to 0 or any value smaller than the interval at which the entity service refreshes.

Add the backend plugin to your Backstage application

1. Create a new file named packages/backend/src/plugins/postmanbackend.ts and add the following to it:

import { Router } from 'express';
import { PluginEnvironment } from '../types';
import { createRouter } from '@postman-solutions/backstage-plugin-postman-backend';

export default async function createPlugin({
  logger,
  config,
}: PluginEnvironment) {
  return await createRouter({ logger, config });
}

2. Next, let's wire this into the overall backend router, edit packages/backend/src/index.ts:

import postmanbackend from './plugins/postmanbackend';
// ...
async function main() {
  // ...
  // Add this line under the other lines that follow the useHotMemoize pattern
  const postmanBackEndEnv = useHotMemoize(module, () => createEnv('postman-backend'));
  // ...
  // Insert this line under the other lines that add their routers to apiRouter in the same way
  apiRouter.use('/postman', await postmanbackend(postmanBackEndEnv));
// ...
}

3. (optional) you can run yarn start-backend from the root directory to start the backend server

Configuring the Postman Entity Provider (optional)

The Postman EntityProvider is an optional component that allows you to dynamically retrieve Postman APIs and collections that have been tagged with a certain Postman tag, e.g. backstage. In order for it to work, you would need to add some more properties to your local app-config.yaml or production app-config.production.yaml file:

postman:
    baseUrl: https://api.postman.com
    apiKey: 
        $env: YOUR_ENVIRONMENT_VARIABLE_NAME
    synchEntitiesWithTag: TAG_NAME
    entityProviderSynchInterval: SYNC_FREQUENCY_IN_MINUTES (optional)    

Additionally, you would need to insert the following lines into your packages/backend/src/plugins/catalog.ts file:

...
// new code after other imports
import { PostmanEntityProvider } from '@postman-solutions/backstage-plugin-postman-backend';
...

...
    const builder = CatalogBuilder.create(env);
    
    // new code after builder got instantiated
    const postmanEntityProvider = PostmanEntityProvider.fromConfig(env.config, {logger: env.logger})
    const postmanEntityProviderSynchInterval = env.config?.getNumber('postman.entityProviderSynchInterval') ?? 5;
    builder.addEntityProvider(postmanEntityProvider);

...

...
    await processingEngine.start();

    // new code after processing engine started
    await env.scheduler.scheduleTask({
      id: 'run_postman_entity_provider_refresh',
      fn: async () => {
        await postmanEntityProvider.run();
      },
      frequency: { minutes: postmanEntityProviderSynchInterval },
      timeout: { minutes: 10 },
    });
...