How do I install the Onboard To Openapi Server skill?

Run npx skillmds@latest add paulasilvatech/onboard-to-openapi-server in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Onboard To Openapi Server safe to use?

SkillMD's automated safety review verdict for this skill is PASS. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Onboard To Openapi Server?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Onboard To Openapi Server free to use?

Yes. Installing skills from SkillMD is free. This skill is licensed under Apache-2.

Who published Onboard To Openapi Server?

paulasilvatech (@paulasilvatech) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Onboard To Openapi Server by paulasilvatech

Name: Onboard To Openapi Server
Author: paulasilvatech

Onboard To Openapi Server

Migrate a Backstage backend plugin from a hand-written Express router to the repository's typed OpenAPI server tooling while preserving routes, auth, permissions, errors, tests, and optional client generation. Use when onboarding createOpenApiRouter or modernizing a router with OpenAPI.

File contents

Onboard a Backstage plugin to the OpenAPI server

Reverse-engineer the current router once, make the OpenAPI specification authoritative, and preserve runtime behavior through generated server types and focused tests.

When to invoke

"Convert this Backstage Express router to createOpenApiRouter."
"Generate an OpenAPI server stub for this backend plugin."
"Add a typed client for this Backstage API."
"Migrate router tests to the OpenAPI wrapper."

Procedure

Confirm Backstage core or compatible fork mode, target plugin, green baseline, and exact source commit.
Read the pinned upstream procedure.
Keep typed client generation, test-wrapper migration, and changesets opt-in unless already required by the task.
Inventory every mounted route, parameter, body, response, error, auth check, permission check, and nested router.
Review the inventory before writing the specification.
Author openapi.yaml as the new source of truth and validate it with repository tooling.
Generate the server stub and switch to createOpenApiRouter without dropping auth, permissions, middleware, or error behavior.
Add or migrate tests for success, validation, auth, permission, and error responses.
Run targeted tests and exact root yarn tsc for Backstage core.
Add optional client, test-wrapper, and changeset work only when in scope.

Output template

## OpenAPI onboarding result

**Plugin:** <path>
**Optional work:** <client, test wrapper, changeset>

| Route | Spec operation | Auth and permission | Test | Status |
| --- | --- | --- | --- | --- |

Quality gate

A green baseline exists before migration.
Every route and nested router is inventoried.
OpenAPI covers parameters, bodies, responses, and errors.
Auth, permissions, middleware, and runtime behavior are preserved.
Generated artifacts and optional work match the approved scope.
Targeted tests and exact root yarn tsc pass.

---name: onboard-to-openapi-serverdescription: Migrate a Backstage backend plugin from a hand-written Express router to the repository's typed OpenAPI server tooling while preserving routes, auth, permissions, errors, tests, and optional client generation. Use when onboarding createOpenApiRouter or modernizing a router with OpenAPI.license: Apache-2.0---# Onboard a Backstage plugin to the OpenAPI serverReverse-engineer the current router once, make the OpenAPI specification authoritative, andpreserve runtime behavior through generated server types and focused tests.## When to invoke- "Convert this Backstage Express router to createOpenApiRouter."- "Generate an OpenAPI server stub for this backend plugin."- "Add a typed client for this Backstage API."- "Migrate router tests to the OpenAPI wrapper."## Procedure1. Confirm Backstage core or compatible fork mode, target plugin, green baseline, and exact source commit.2. Read [the pinned upstream procedure](references/upstream/SKILL.md).3. Keep typed client generation, test-wrapper migration, and changesets opt-in unless already required by the task.4. Inventory every mounted route, parameter, body, response, error, auth check, permission check, and nested router.5. Review the inventory before writing the specification.6. Author `openapi.yaml` as the new source of truth and validate it with repository tooling.7. Generate the server stub and switch to `createOpenApiRouter` without dropping auth, permissions, middleware, or error behavior.8. Add or migrate tests for success, validation, auth, permission, and error responses.9. Run targeted tests and exact root `yarn tsc` for Backstage core.10. Add optional client, test-wrapper, and changeset work only when in scope.## Output template```markdown## OpenAPI onboarding result**Plugin:** <path>**Optional work:** <client, test wrapper, changeset>| Route | Spec operation | Auth and permission | Test | Status || --- | --- | --- | --- | --- |```## Quality gate- [ ] A green baseline exists before migration.- [ ] Every route and nested router is inventoried.- [ ] OpenAPI covers parameters, bodies, responses, and errors.- [ ] Auth, permissions, middleware, and runtime behavior are preserved.- [ ] Generated artifacts and optional work match the approved scope.- [ ] Targeted tests and exact root `yarn tsc` pass.

Frequently asked questions