6fb794bc79
* Delete outdated development instructions for Next.js + Tailwind and Python; add comprehensive guidelines for PostgreSQL DBA, Angular, ASP.NET REST APIs, Azure Functions with TypeScript, Bicep, Blazor, CMake with vcpkg, C#, .NET MAUI, GenAIScript, Terraform for Azure, localization, and markdown standards. * Update documentation and prompts for consistency and clarity - Standardized description formatting in various markdown files to use single quotes. - Added error handling utility in update-readme.js for safer file operations. - Improved title extraction logic in update-readme.js to handle frontmatter more robustly. - Updated chat modes section in README to reflect new emoji and sorted chat mode links. - Cleaned up various instruction files for better readability and consistency. - Ensured all markdown files end with a newline for better compatibility with version control. * Remove standardize-frontmatter.js script * Add usage instructions for creating and switching chat modes in README.md * Update README.md generation script to enhance instructions and usage details for custom chat modes * Update README.md and update-readme.js for improved instruction clarity and consistency * Refactor README.md links and update readme script for improved clarity and consistency in instructions * Update README.md and update-readme.js for improved instruction clarity and consistency * Changing from a patch to regen approach for the readme * Bit more cleanup for how to show things in the readme * Adding missing description * Another missing description --------- Co-authored-by: Aaron Powell <me@aaron-powell.com>
44 lines
1.8 KiB
Markdown
44 lines
1.8 KiB
Markdown
---
|
|
mode: 'agent'
|
|
tools: ['changes', 'codebase', 'editFiles', 'problems']
|
|
description: 'Create ASP.NET Minimal API endpoints with proper OpenAPI documentation'
|
|
---
|
|
|
|
# ASP.NET Minimal API with OpenAPI
|
|
|
|
Your goal is to help me create well-structured ASP.NET Minimal API endpoints with correct types and comprehensive OpenAPI/Swagger documentation.
|
|
|
|
## API Organization
|
|
|
|
- Group related endpoints using `MapGroup()` extension
|
|
- Use endpoint filters for cross-cutting concerns
|
|
- Structure larger APIs with separate endpoint classes
|
|
- Consider using a feature-based folder structure for complex APIs
|
|
|
|
## Request and Response Types
|
|
|
|
- Define explicit request and response DTOs/models
|
|
- Create clear model classes with proper validation attributes
|
|
- Use record types for immutable request/response objects
|
|
- Use meaningful property names that align with API design standards
|
|
- Apply `[Required]` and other validation attributes to enforce constraints
|
|
|
|
## Type Handling
|
|
|
|
- Use strongly-typed route parameters with explicit type binding
|
|
- Apply proper parameter binding with `[FromBody]`, `[FromRoute]`, `[FromQuery]`
|
|
- Use `Results<T1, T2>` to represent multiple response types
|
|
- Return `TypedResults` instead of `Results` for strongly-typed responses
|
|
- Leverage C# 10+ features like nullable annotations and init-only properties
|
|
|
|
## OpenAPI / Swagger Documentation
|
|
|
|
- Add explicit OpenAPI operation details with `.WithOpenApi()`
|
|
- Define operation summary and description
|
|
- Document response types with `.Produces<T>(statusCode)`
|
|
- Document request bodies with `.WithRequestBody()`
|
|
- Set proper content types for requests and responses
|
|
- Include examples using `SwaggerRequestExampleAttribute`
|
|
- Document authentication requirements with `.RequireAuthorization()`
|
|
- Use XML documentation comments for descriptive API documentation
|