菜单
Set up OpenAPI client for authenticated API calls in Umbraco backoffice (REQUIRED for custom APIs)
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/umbraco/Umbraco-CMS-Backoffice-Skills --skill umbraco-openapi-client命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
Run tests from skill examples and generate a report (project)
Validate links and references in SKILL.md files using deterministic scripts
Umbraco backoffice extension customisation - complete working examples showing how extension types combine
正在显示 SKILL.md
基于 SOC 职业分类
| name | umbraco-openapi-client |
| description | Set up OpenAPI client for authenticated API calls in Umbraco backoffice (REQUIRED for custom APIs) |
| version | 1.0.0 |
| location | managed |
| allowed-tools | Read, Write, Edit, Bash |
NEVER use raw fetch() calls for Umbraco backoffice API communication. Raw fetch calls will result in 401 Unauthorized errors because they don't include the bearer token authentication that Umbraco requires.
ALWAYS use a generated OpenAPI client configured with Umbraco's auth context. This ensures:
Use this pattern whenever you:
[BackOfficeRoute]The setup has 4 parts:
@hey-api/openapi-ts (the @hey-api/client-fetch plugin is bundled with it)Your API must be exposed as a backoffice OpenAPI document. Create a composer:
Umbraco 18+: The OpenAPI stack moved off Swashbuckle's
SwaggerGenOptions(and theBackOfficeSecurityRequirementsOperationFilterBase/OperationIdHandlertypes) to a fluentAddBackOfficeOpenApiDocument(...)builder. Use the pattern below; the oldSwaggerGenOptionsapproach no longer compiles on v18.
// Composers/MyApiComposer.cs
using Umbraco.Cms.Api.Common.OpenApi;
using Umbraco.Cms.Api.Management.OpenApi;
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.DependencyInjection;
namespace MyExtension.Composers;
public class MyApiComposer : IComposer
{
public void Compose(IUmbracoBuilder builder) =>
// Registers a dedicated backoffice OpenAPI document, served at
// /umbraco/swagger/{ApiName}/swagger.json and browsable via Swagger UI.
// See https://docs.umbraco.com/umbraco-cms/extend-your-project/tutorials/creating-a-backoffice-api
builder.AddBackOfficeOpenApiDocument(
Constants.ApiName,
document => document
.WithTitle("My Extension API")
.WithBackOfficeAuthentication()
.WithJsonOptions(Umbraco.Cms.Core.Constants.JsonOptionsNames.BackOffice)
.ConfigureOpenApiOptions(options =>
options.AddDocumentTransformer((doc, _, _) =>
{
doc.Info.Version = "1.0";
return Task.CompletedTask;
})));
}
// Constants
public static class Constants
{
public const string ApiName = "myextension";
}
Add to your Client/package.json:
{
"scripts": {
"generate-client": "node scripts/generate-openapi.js https://localhost:44325/umbraco/swagger/myextension/swagger.json"
},
"devDependencies": {
"@hey-api/openapi-ts": "^0.97.0",
"chalk": "^5.4.1",
"node-fetch": "^3.3.2"
}
}
Create Client/scripts/generate-openapi.js:
import fetch from "node-fetch";
import chalk from "chalk";
import { createClient, defaultPlugins } from "@hey-api/openapi-ts";
console.log(chalk.green("Generating OpenAPI client..."));
const swaggerUrl = process.argv[2];
if (swaggerUrl === undefined) {
console.error(chalk.red(`ERROR: Missing URL to OpenAPI spec`));
process.exit(1);
}
// Ignore self-signed certificates on localhost
process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
console.log(`Fetching OpenAPI definition from ${chalk.yellow(swaggerUrl)}`);
fetch(swaggerUrl)
.then(async (response) => {
if (!response.ok) {
console.error(chalk.red(`ERROR: ${response.status} ${response.statusText}`));
return;
}
await createClient({
input: swaggerUrl,
output: "src/api",
plugins: [
...defaultPlugins,
{
name: "@hey-api/client-fetch",
bundle: true,
exportFromIndex: true,
throwOnError: true,
},
{
name: "@hey-api/typescript",
enums: "typescript",
},
{
name: "@hey-api/sdk",
asClass: true,
},
],
});
console.log(chalk.green("Client generated successfully!"));
})
.catch((error) => {
console.error(`ERROR: ${chalk.red(error.message)}`);
});
Configure the generated client with Umbraco's auth context in your entry point:
// src/entrypoints/entrypoint.ts
import type { UmbEntryPointOnInit, UmbEntryPointOnUnload } from "@umbraco-cms/backoffice/extension-api";
import { UMB_AUTH_CONTEXT } from "@umbraco-cms/backoffice/auth";
import { client } from "../api/client.gen.js";
export const onInit: UmbEntryPointOnInit = (host, _extensionRegistry) => {
// CRITICAL: Configure the OpenAPI client with authentication
host.consumeContext(UMB_AUTH_CONTEXT, (authContext) => {
if (!authContext) return;
const config = authContext.getOpenApiConfiguration();
client.setConfig({
baseUrl: config.base,
credentials: config.credentials,
auth: config.token, // This provides the bearer token!
});
console.log("API client configured with auth");
});
};
export const onUnload: UmbEntryPointOnUnload = (_host, _extensionRegistry) => {
// Cleanup if needed
};
After running npm run generate-client, use the generated service:
// In your workspace context, repository, or data source
import { MyExtensionService } from "../api/index.js";
// The client handles auth automatically!
const response = await MyExtensionService.getItems({
query: { skip: 0, take: 50 },
});
const item = await MyExtensionService.getItem({
path: { id: "some-guid" },
});
await MyExtensionService.createItem({
body: { name: "New Item", value: 123 },
});
npm run generate-clientsrc/api/:
types.gen.ts - TypeScript types from your C# modelssdk.gen.ts - Service class with typed methodsclient.gen.ts - HTTP client configurationindex.ts - Re-exports everything// This will get 401 Unauthorized!
const response = await fetch('/umbraco/myextension/api/v1/items');
// Still fails - cookies don't work for Management API
const response = await fetch('/umbraco/myextension/api/v1/items', {
credentials: 'include'
});
// Client is configured with bearer token in entry point
const response = await MyExtensionService.getItems();
See the complete working implementation in:
examples/notes-wiki/Client/ - Full OpenAPI client setupexamples/tree-example/Client/ - Tree with OpenAPI integrationComposers/MyApiComposer.cs - Swagger registrationClient/scripts/generate-openapi.js - Generation scriptClient/src/entrypoints/entrypoint.ts - Auth configurationClient/src/api/ - Generated (don't edit manually)That's it! Always generate your API client and configure it with auth. Never use raw fetch for authenticated endpoints.