api-conventions
MX Space API design conventions. Apply when writing controllers, API endpoints, or handling HTTP requests.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
MX Space API design conventions. Apply when writing controllers, API endpoints, or handling HTTP requests.
How to use
Zainstaluj umiejętność w swoim projekcie MX Space, umieszczając plik w katalogu .claude/skills/api-conventions. Umiejętność nie jest bezpośrednio wywoływana przez użytkownika, ale Claude automatycznie stosuje jej reguły podczas generowania lub recenzji kodu kontrolerów.
Podczas definiowania nowych kontrolerów zawsze używaj dekoratora @ApiController zamiast @Controller – system automatycznie doda prefiks /api/v{version} w środowisku produkcyjnym.
Dla endpointów wymagających logowania zastosuj dekorator @Auth(), a dla opcjonalnej autentykacji użyj @IsAuthenticated() lub @CurrentUser() w zależności od potrzeby dostępu do danych użytkownika.
Pamiętaj, że ResponseInterceptor automatycznie transformuje odpowiedzi: tablice zawijane są w {data: [...]}, obiekty zwracane są bezpośrednio, undefined zwraca 204 No Content, a @Paginator dodaje metadane paginacji. Jeśli chcesz pominąć transformację, użyj @Bypass.
Dla endpointów z paginacją dodaj dekorator @HTTPDecorators.Paginator i zwróć wynik z mongoose.paginate(), przekazując page i limit z PagerDto.
Waliduj parametry ścieżki (@Param), query (@Query) i body (@Body) za pomocą odpowiednich DTO – system automatycznie konwertuje nazwy pól z camelCase na snake_case w odpowiedziach JSON.