How does this skill improve API documentation?

It enforces the use of [ProducesResponseType] for all possible status codes (200, 201, 400, 404, etc.), ensuring that Swagger and other OpenAPI tools generate precise documentation for frontend developers.

Why does the skill recommend using CancellationToken?

Including a CancellationToken in every async action allows the server to cancel long-running operations if the client disconnects, improving resource management and application performance.

What is the benefit of the [ApiController] attribute in this skill?

The [ApiController] attribute enables automatic 400 Bad Request responses for invalid model states, reducing boilerplate code and ensuring consistent validation behavior across your API.

Does this skill help with architectural design?

Yes, it promotes the 'Thin Controller' principle, which ensures controllers only handle HTTP-related tasks while delegating business logic to dedicated services, leading to cleaner code.

ASP.NET Core Controller Best Practices

Name: ASP.NET Core Controller Best Practices
Author: andychang0121

byandychang0121

0•

API 开发

Standardizes ASP.NET Core API development by enforcing RESTful conventions, thin controller patterns, and comprehensive Swagger documentation.

This skill provides specialized guidance for building high-quality ASP.NET Core Web APIs. It helps developers implement the [ApiController] attribute for automatic validation, follow strict RESTful routing conventions, and ensure API endpoints are properly documented with [ProducesResponseType]. By promoting the 'Thin Controller' pattern, it assists in delegating business logic to service layers, resulting in more maintainable, testable, and scalable C# backend applications. It is an essential tool for developers looking to modernize their .NET API architecture and improve documentation for frontend consumers.

主要功能

01Standardized RESTful route naming and parameter constraints

02Promotion of thin controllers and service layer delegation

03Standardized async patterns with CancellationToken integration

04Automatic ModelState validation using [ApiController] enforcement

050 GitHub stars

06Comprehensive Swagger documentation through [ProducesResponseType] patterns

使用场景

01Generating accurate and complete OpenAPI/Swagger documentation for API consumers

02Refactoring bloated controllers to improve code separation and testability

03Scaffolding new RESTful API endpoints with production-ready standards

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add andychang0121/dotnet-skills aspnetcore-controller-best-practices

For use in Claude.ai and ChatGPT

主要功能

01Standardized RESTful route naming and parameter constraints

02Promotion of thin controllers and service layer delegation

03Standardized async patterns with CancellationToken integration

04Automatic ModelState validation using [ApiController] enforcement

050 GitHub stars

06Comprehensive Swagger documentation through [ProducesResponseType] patterns

使用场景

01Generating accurate and complete OpenAPI/Swagger documentation for API consumers

02Refactoring bloated controllers to improve code separation and testability

03Scaffolding new RESTful API endpoints with production-ready standards

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add andychang0121/dotnet-skills aspnetcore-controller-best-practices

For use in Claude.ai and ChatGPT