skills.rest
umbraco
umbracoOFFICIAL
Explore all skills by this author →
WebsiteGitHub

umbraco-openapi-client

Generate an OpenAPI client with bearer token authentication for Umbraco backoffice APIs.

26|13|Updated Nov 30, 2025
Search Tags:#typescript#authentication#api#openapi#umbraco#client generation
One-click install
npx skills add https://github.com/umbraco/Umbraco-CMS-Backoffice-Skills --skill umbraco-openapi-client
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: umbraco-openapi-client
Source: https://github.com/umbraco/Umbraco-CMS-Backoffice-Skills/tree/main/plugins/umbraco-backoffice-skills/skills/umbraco-openapi-client
Command: npx skills add https://github.com/umbraco/Umbraco-CMS-Backoffice-Skills --skill umbraco-openapi-client

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @hey-api/client-fetch, @hey-api/openapi-ts, chalk, node-fetch, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures secure and authenticated API calls from the Umbraco backoffice to custom APIs, preventing unauthorized access and ensuring data integrity.

Core Features & Use Cases

  • Secure API Communication: Automatically handles bearer token authentication for Umbraco backoffice API calls.
  • Type-Safe Clients: Generates TypeScript clients from OpenAPI specifications for robust API interactions.
  • Use Case: When building a custom section in the Umbraco backoffice that needs to fetch or send data to your own C# API controllers, this skill provides the essential setup to do so securely and efficiently.

Quick Start

Set up the OpenAPI client for authenticated API calls in Umbraco by following the step-by-step implementation guide.

Frequently Asked Questions about umbraco-openapi-client

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

FAQPage Schema
How do I fix 401 Unauthorized errors when calling custom Umbraco APIs from the backoffice?▼

Type-safe OpenAPI clients generate TypeScript definitions from Swagger specifications, ensuring robust API interactions within the Umbraco backoffice. This mechanism provides compile-time type checking and automatically handles bearer token authentication for secure data fetching.

How do I generate an OpenAPI client for Umbraco backoffice API integration?▼

Generating an Umbraco OpenAPI client requires a C# backend with Swagger documentation, client-side dependencies like @hey-api/openapi-ts, and a generation script. Ensure your environment supports TypeScript to successfully produce the authenticated client.

Does the Umbraco OpenAPI client generation work with my existing C# Swagger documentation?▼

Using @hey-api/openapi-ts for Umbraco client generation is the best way to ensure type-safe API interactions compared to manual fetch calls. It automatically maps Swagger specifications to TypeScript definitions while handling bearer token authentication natively.

Why does my Umbraco backoffice client return 401 Unauthorized on authenticated API routes?▼

Your Umbraco backoffice client returns 401 Unauthorized when the entry point lacks proper bearer token configuration. Configuring the OpenAPI client to automatically attach authentication tokens resolves this access issue and ensures data integrity.

Related Skills

Explore More Software Engineering Skills→
albanistalbanist
4

umbraco-openapi-client

Generate a type-safe TypeScript OpenAPI client for Umbraco custom APIs.

Community
Intermediate
1k-off1k-off
1

umbraco-openapi-client

Configure a generated OpenAPI TypeScript client with Umbraco bearer-token authentication.

Community
Intermediate
kraftvaerkkraftvaerk

umbraco-openapi-client

Sets up authenticated OpenAPI clients for Umbraco backoffice frontend integrations.

Official
Intermediate
mgd34msumgd34msu
4

openapi

Generate TypeScript types and client SDKs from OpenAPI 3.1 specifications.

Community
Advanced