endpoint-implementation
Use this skill to implement endpoints in the API
When & Why to Use This Skill
This Claude skill streamlines the implementation of API endpoints by adhering to a structured feature-slice architecture. It automates the creation of C# record classes for commands, responses, and events, while ensuring that business logic is consistently organized within the Wolverine framework. By following predefined guidelines for file structure and HTTP routing, it helps developers maintain a clean, scalable, and standardized codebase.
Use Cases
- Rapid Scaffolding: Quickly generate the boilerplate code for new API endpoints, including command/response records and endpoint classes, to accelerate feature development.
- Architectural Consistency: Ensure all team members follow the 'feature slice' pattern and Wolverine-based routing conventions, reducing technical debt and improving code readability.
- Event-Driven Development: Automatically structure endpoints to return not just responses, but also events and side-effects, facilitating a robust event-driven architecture.
- Standardized Validation: Implement custom validation logic within the endpoint structure to complement FluentValidation, ensuring data integrity across all API interactions.
| name | endpoint-implementation |
|---|---|
| description | Use this skill to implement endpoints in the API |
Structure of an endpoint slice
Read the docs/architecture/05-building-block-view.md file to understand how feature groups and feature slices are structured. Each endpoint is a feature slice with a specific structure described below.
File structure
- Users/ # Feature group
- Prompts/ # Feature group
- Repositories/ # Feature group
- OnboardUserRepository.cs # Feature slice
- Repository.cs # Aggregate root
- UserRepositoryDetails.cs # Read model
- Skills/ # Feature group
Endpoint code guidelines
- Use a record class to model the command, for example:
OnboardUserRepository - Use a record class to model the response
OnboardUserRepositoryResponse - Use a record class to model any events
UserRepositoryOnboarded - Use a class postfixed with
Endpointe.g.OnboardUserRepositoryEndpointto structure the endpoint - Use a method called
Handlefor the business logic in the endpoint.- Use the
[WolverinePost("<url>")],[WolverineGet("<url>")],[WolverinePutt("<url>")]or[WolverineDelete("<url>")]attributes to enable access via HTTP. - The method should return a tuple where the first element is the response object, the second element the event, and the final element the optional side-effects.
- Use the
- Use a
Validatemethod for any custom validations that you can't model with FluentValidation validators