dotnet-api

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

dotnet-api

dotnet-api

Overview

概述

ASP.NET Core APIs, data access, backend services, security, and cloud-native patterns. This consolidated skill spans 32 topic areas. Load the appropriate companion file from
references/
based on the routing table below.
Baseline dependency:
references/minimal-apis.md
defines the core ASP.NET Core Minimal API patterns (route groups, endpoint filters, TypedResults, parameter binding) that apply to most API development tasks. Load it by default when building HTTP endpoints.
Most-shared companion:
references/architecture-patterns.md
covers vertical slices, request pipelines, error handling, caching, and idempotency patterns used across nearly all ASP.NET Core projects.
ASP.NET Core API、数据访问、后端服务、安全及云原生模式。该整合技能覆盖32个主题领域。请根据下方的路由表从
references/
目录加载对应的配套文件。
基线依赖:
references/minimal-apis.md
定义了核心的ASP.NET Core Minimal API模式(路由组、端点过滤器、TypedResults、参数绑定),适用于大多数API开发任务。构建HTTP端点时默认加载该文件。
最常用的配套文件:
references/architecture-patterns.md
涵盖了垂直切片、请求管道、错误处理、缓存和幂等性模式,几乎所有ASP.NET Core项目都会用到这些内容。

Routing Table

路由表

TopicKeywordsDescriptionCompanion File
Minimal APIsendpoint, route group, filter, TypedResultsMinimal API route groups, filters, TypedResults, OpenAPIreferences/minimal-apis.md
Middlewarepipeline ordering, short-circuit, exceptionPipeline ordering, short-circuit, exception handlingreferences/middleware-patterns.md
EF Core patternsDbContext, migrations, AsNoTrackingDbContext, AsNoTracking, query splitting, migrationsreferences/efcore-patterns.md
EF Core architectureread/write split, aggregate boundaries, N+1Read/write split, aggregate boundaries, N+1references/efcore-architecture.md
Data access strategyEF Core vs Dapper vs ADO.NET decisionEF Core vs Dapper vs ADO.NET decision matrixreferences/data-access-strategy.md
gRPCproto, code-gen, streaming, authProto definition, code-gen, ASP.NET Core host, streamingreferences/grpc.md
Real-timeSignalR, SSE, JSON-RPC, gRPC streamingSignalR hubs, SSE, JSON-RPC 2.0, scalingreferences/realtime-communication.md
ResiliencePolly v8, retry, circuit breaker, timeoutPolly v8 retry, circuit breaker, timeout, rate limiterreferences/resilience.md
HTTP clientIHttpClientFactory, typed/named, DelegatingHandlerIHttpClientFactory, typed/named clients, DelegatingHandlersreferences/http-client.md
API versioningAsp.Versioning, URL/header/query, sunsetAsp.Versioning.Http/Mvc, URL/header/query, sunsetreferences/api-versioning.md
OpenAPIMS.AspNetCore.OpenApi, Swashbuckle, NSwagMS.AspNetCore.OpenApi, Swashbuckle migration, NSwagreferences/openapi.md
API securityIdentity, OAuth/OIDC, JWT, CORS, rate limitingIdentity, OAuth/OIDC, JWT bearer, CORS, rate limitingreferences/api-security.md
OWASPinjection, auth, XSS, deprecated APIsOWASP Top 10 hardening for .NETreferences/security-owasp.md
Secretsuser secrets, env vars, rotationUser secrets, environment variables, rotationreferences/secrets-management.md
CryptographyAES-GCM, RSA, ECDSA, hashing, key derivationAES-GCM, RSA, ECDSA, hashing, PQC key derivationreferences/cryptography.md
Background servicesBackgroundService, IHostedService, lifecycleBackgroundService, IHostedService, lifecyclereferences/background-services.md
AspireAppHost, service discovery, dashboardAppHost, service discovery, components, dashboardreferences/aspire-patterns.md
Semantic KernelAI/LLM plugins, prompts, memory, agentsAI/LLM plugins, prompt templates, memory, agentsreferences/semantic-kernel.md
Architecturevertical slices, layered, pipelines, cachingVertical slices, layered, pipelines, cachingreferences/architecture-patterns.md
MessagingWolverine, Azure Service Bus, RabbitMQ, pub/sub, sagasWolverine, Azure Service Bus, RabbitMQ, pub/sub, sagasreferences/messaging-patterns.md
Service communicationREST vs gRPC vs SignalR decision matrixREST vs gRPC vs SignalR decision matrixreferences/service-communication.md
API surface validationPublicApiAnalyzers, Verify, ApiCompatPublicApiAnalyzers, Verify snapshots, ApiCompatreferences/api-surface-validation.md
Library API compatbinary/source compat, type forwardersBinary/source compat, type forwarders, SemVerreferences/library-api-compat.md
I/O pipelinesPipeReader/PipeWriter, backpressure, KestrelPipeReader/PipeWriter, backpressure, Kestrelreferences/io-pipelines.md
Agent gotchasasync misuse, NuGet errors, DI mistakesCommon agent mistakes in .NET codereferences/agent-gotchas.md
File-based apps.NET 10, directives, csproj migration.NET 10 file-based C# appsreferences/file-based-apps.md
API docsDocFX, OpenAPI-as-docs, versioned docsDocFX, OpenAPI-as-docs, versioned documentationreferences/api-docs.md
HybridCacheHybridCache, L1/L2, stampede, tag evictionHybridCache (.NET 9+), stampede protection, tag-based evictionreferences/hybrid-cache.md
YARPreverse proxy, load balancing, API gateway, BFFYARP reverse proxy, load balancing, health checks, transformsreferences/yarp.md
Output cachingOutputCache, response caching, compressionOutput/response caching, compression, CDN, tag invalidationreferences/output-caching.md
IdentityASP.NET Core Identity, login, MFA, scaffoldingIdentity setup, scaffolding, external providers, MapIdentityApireferences/identity-setup.md
Office documents and PDFExcel, Word, PowerPoint, PDF, Open XML SDK, spreadsheet, docx, xlsx, PDFsharp, MigraDoc, merge PDF, split PDF, watermarkOpen XML SDK, ClosedXML, PDFsharp/MigraDoc for PDF create/read/merge/split/watermarkreferences/office-documents.md
主题关键词描述配套文件
Minimal APIsendpoint, route group, filter, TypedResultsMinimal API路由组、过滤器、TypedResults、OpenAPIreferences/minimal-apis.md
Middlewarepipeline ordering, short-circuit, exception管道排序、短路处理、异常处理references/middleware-patterns.md
EF Core patternsDbContext, migrations, AsNoTrackingDbContext、AsNoTracking、查询拆分、迁移references/efcore-patterns.md
EF Core architectureread/write split, aggregate boundaries, N+1读写分离、聚合边界、N+1问题references/efcore-architecture.md
Data access strategyEF Core vs Dapper vs ADO.NET decisionEF Core、Dapper、ADO.NET选型矩阵references/data-access-strategy.md
gRPCproto, code-gen, streaming, authProto定义、代码生成、ASP.NET Core宿主、流式传输references/grpc.md
Real-timeSignalR, SSE, JSON-RPC, gRPC streamingSignalR集线器、SSE、JSON-RPC 2.0、扩缩容references/realtime-communication.md
ResiliencePolly v8, retry, circuit breaker, timeoutPolly v8重试、断路器、超时、速率限制references/resilience.md
HTTP clientIHttpClientFactory, typed/named, DelegatingHandlerIHttpClientFactory、类型化/命名客户端、DelegatingHandlerreferences/http-client.md
API versioningAsp.Versioning, URL/header/query, sunsetAsp.Versioning.Http/Mvc、URL/Header/Query版本控制、版本淘汰references/api-versioning.md
OpenAPIMS.AspNetCore.OpenApi, Swashbuckle, NSwagMS.AspNetCore.OpenApi、Swashbuckle迁移、NSwagreferences/openapi.md
API securityIdentity, OAuth/OIDC, JWT, CORS, rate limitingIdentity、OAuth/OIDC、JWT承载认证、CORS、速率限制references/api-security.md
OWASPinjection, auth, XSS, deprecated APIs.NET项目OWASP Top 10加固方案references/security-owasp.md
Secretsuser secrets, env vars, rotation用户密钥、环境变量、密钥轮换references/secrets-management.md
CryptographyAES-GCM, RSA, ECDSA, hashing, key derivationAES-GCM、RSA、ECDSA、哈希、后量子密码学密钥派生references/cryptography.md
Background servicesBackgroundService, IHostedService, lifecycleBackgroundService、IHostedService、生命周期references/background-services.md
AspireAppHost, service discovery, dashboardAppHost、服务发现、组件、仪表板references/aspire-patterns.md
Semantic KernelAI/LLM plugins, prompts, memory, agentsAI/LLM插件、提示词模板、记忆、Agentreferences/semantic-kernel.md
Architecturevertical slices, layered, pipelines, caching垂直切片、分层架构、管道、缓存references/architecture-patterns.md
MessagingWolverine, Azure Service Bus, RabbitMQ, pub/sub, sagasWolverine、Azure Service Bus、RabbitMQ、发布订阅、Sagareferences/messaging-patterns.md
Service communicationREST vs gRPC vs SignalR decision matrixREST、gRPC、SignalR选型矩阵references/service-communication.md
API surface validationPublicApiAnalyzers, Verify, ApiCompatPublicApiAnalyzers、Verify快照、ApiCompatreferences/api-surface-validation.md
Library API compatbinary/source compat, type forwarders二进制/源码兼容性、类型转发、语义化版本references/library-api-compat.md
I/O pipelinesPipeReader/PipeWriter, backpressure, KestrelPipeReader/PipeWriter、背压、Kestrelreferences/io-pipelines.md
Agent gotchasasync misuse, NuGet errors, DI mistakes.NET代码中常见的Agent错误references/agent-gotchas.md
File-based apps.NET 10, directives, csproj migration.NET 10基于文件的C#应用references/file-based-apps.md
API docsDocFX, OpenAPI-as-docs, versioned docsDocFX、基于OpenAPI的文档、版本化文档references/api-docs.md
HybridCacheHybridCache, L1/L2, stampede, tag evictionHybridCache(.NET 9+)、缓存击穿防护、基于标签的驱逐references/hybrid-cache.md
YARPreverse proxy, load balancing, API gateway, BFFYARP反向代理、负载均衡、健康检查、转换规则references/yarp.md
Output cachingOutputCache, response caching, compression输出/响应缓存、压缩、CDN、标签失效references/output-caching.md
IdentityASP.NET Core Identity, login, MFA, scaffoldingIdentity配置、脚手架、外部登录提供者、MapIdentityApireferences/identity-setup.md
Office documents and PDFExcel, Word, PowerPoint, PDF, Open XML SDK, spreadsheet, docx, xlsx, PDFsharp, MigraDoc, merge PDF, split PDF, watermarkOpen XML SDK、ClosedXML、PDFsharp/MigraDoc用于PDF的创建/读取/合并/拆分/加水印references/office-documents.md

Scope

适用范围

  • ASP.NET Core web APIs (minimal and controller-based)
  • Data access (EF Core, Dapper, ADO.NET)
  • Service communication (gRPC, SignalR, SSE, messaging)
  • Security (auth, OWASP, secrets, crypto)
  • Cloud-native (Aspire, resilience, background services)
  • AI integration (Semantic Kernel)
  • Architecture patterns and API surface validation
  • ASP.NET Core Web API(Minimal和基于控制器的)
  • 数据访问(EF Core、Dapper、ADO.NET)
  • 服务通信(gRPC、SignalR、SSE、消息传递)
  • 安全(身份验证、OWASP、密钥管理、加密)
  • 云原生(Aspire、弹性机制、后台服务)
  • AI集成(Semantic Kernel)
  • 架构模式与API表面验证

Out of scope

不适用范围

  • C# language features -> [skill:dotnet-csharp]
  • UI rendering -> [skill:dotnet-ui]
  • Test authoring -> [skill:dotnet-testing]
  • CI/CD pipelines -> [skill:dotnet-devops]
  • Build tooling -> [skill:dotnet-tooling]
  • C#语言特性 -> [skill:dotnet-csharp]
  • UI渲染 -> [skill:dotnet-ui]
  • 测试编写 -> [skill:dotnet-testing]
  • CI/CD流水线 -> [skill:dotnet-devops]
  • 构建工具 -> [skill:dotnet-tooling]