skills.rest
olafkfreund
olafkfreundCOMMUNITY
Explore all skills by this author →
GitHub

onboard-to-openapi-server

Migrate Backstage Express routers to typed OpenAPI tooling.

Updated Jun 4, 2026
Search Tags:#OpenAPI#Backstage#router migration#typed API#backend plugin
One-click install
npx skills add https://github.com/olafkfreund/backstage --skill onboard-to-openapi-server-olafkfreund
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: onboard-to-openapi-server
Source: https://github.com/olafkfreund/backstage/tree/main/.agents/skills/onboard-to-openapi-server
Command: npx skills add https://github.com/olafkfreund/backstage --skill onboard-to-openapi-server-olafkfreund

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill assists in migrating hand-written Express routers from existing Backstage backend plugins to typed OpenAPI tooling, streamlining the transition to a more robust and maintainable codebase.

Core Features & Use Cases

  • Router Migration: Converts Express routers to typed OpenAPI specifications.
  • Server Stub Generation: Generates server stubs using backstage-repo-tools.
  • Client Generation: Optionally generates typed clients for API interaction.
  • Test Migration: Migrates router tests to the OpenAPI test wrapper.
  • Use Case: Ideal for plugins with complex routers, aiming to improve maintainability and leverage the benefits of typed OpenAPI.

Quick Start

Run the skill on your plugin's directory with the command: yarn --cwd <plugin-dir> generate

Frequently Asked Questions about onboard-to-openapi-server

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I migrate an Express router to typed OpenAPI in a Backstage plugin?▼

To migrate an Express router to typed OpenAPI, this skill converts existing hand-written Backstage backend plugin routers into typed OpenAPI specifications and generates server stubs to streamline the transition.

Can I generate typed clients when migrating my Backstage backend plugin to OpenAPI?▼

Yes, you can optionally generate typed clients for API interaction when migrating your Backstage backend plugin, ensuring robust and maintainable typed API communication across your monorepo setup.

How do I migrate router tests to the OpenAPI test wrapper in Backstage?▼

Migrating router tests to the OpenAPI test wrapper is handled optionally during the conversion process, updating your existing Backstage plugin test suite to align with the newly generated typed OpenAPI server stubs.

What do I need to convert a Backstage Express router to typed OpenAPI tooling?▼

Converting a Backstage Express router to typed OpenAPI tooling requires a monorepo setup and an existing backend plugin containing a hand-written Express router to successfully generate server stubs and typed clients.

Why migrate hand-written Express routers to typed OpenAPI for Backstage plugins?▼

Migrating hand-written Express routers to typed OpenAPI improves backend plugin maintainability and leverages typed API benefits, providing a more robust codebase structure through generated server stubs and typed clients.

Related Skills

Explore More Software Engineering Skills→
jacobduijzerjacobduijzer

onboard-to-openapi-server

Convert an Express router in a Backstage backend plugin to an OpenAPI-based router.

Community
Advanced
MassimilianoPiliMassimilianoPili

fe-vue

Develop Vue 3/TypeScript components with Composition API, Pinia, and Vitest.

Community
Advanced
olafkfreundolafkfreund

plugin-analytics-instrumentation

Instrument Backstage plugins with analytics events using React hooks.

Community
Intermediate
manastalukdarmanastalukdar
1

api-mock

Generate API mock servers from OpenAPI specs, GraphQL schemas, or code.

Community
Advanced