Menu
Swagger/OpenAPI setup and documentation patterns for SE104_VLEAGUE
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
A direct command skips the review prompt. Inspect the source before running it.
npx skills add https://github.com/daithang-organization/SE104_VLEAGUE --skill api-documentationThe command stays on one line. Scroll horizontally to inspect it before copying.
Prefer a local copy? Download the files currently available to SkillsMP.
Showing SKILL.md
Based on SOC occupation classification
| name | API Documentation |
| description | Swagger/OpenAPI setup and documentation patterns for SE104_VLEAGUE |
Swagger UI available at /api/docs (set up in main.ts).
const config = new DocumentBuilder()
.setTitle('VLeague API')
.setDescription('V-League Football Management System API')
.setVersion('1.0')
.addBearerAuth(
{
type: 'http',
scheme: 'bearer',
bearerFormat: 'JWT',
name: 'JWT',
description: 'Enter JWT access token',
in: 'header',
},
'access-token',
)
.addTag('Authentication', 'User authentication endpoints')
.addTag('Teams', 'Team management endpoints')
.addTag('Players', )
.(, )
.(, )
.(, )
.(, )
.(, )
.(, )
.(, )
.(, )
.(, )
.(, )
.(, )
.();
= .(app, config);
.(, app, );
@ApiTags('Teams')
@Controller('teams')
export class TeamsController {
@Get()
@ApiOperation({ summary: 'List all teams' })
@ApiResponse({ status: 200, description: 'Teams retrieved successfully' })
@Public()
findAll(@Query() query: PaginationQueryDto) {}
@Post()
@ApiOperation({ summary: 'Create a team' })
@ApiResponse({ status: 201, description: 'Team created' })
@ApiResponse({ status: 409, description: 'Team name already exists' })
@ApiBearerAuth()
@Roles(UserRole.ADMIN)
create(@Body() dto: CreateTeamDto) {}
}
export class CreateTeamDto {
@ApiProperty({ description: 'Team name', example: 'Hoàng Anh Gia Lai' })
@IsString()
@IsNotEmpty()
name: string;
@ApiPropertyOptional({ description: 'Short name', example: 'HAGL' })
@IsOptional()
@IsString()
shortName?: string;
@ApiPropertyOptional({ description: 'City', example: 'Pleiku' })
@IsOptional()
@IsString()
city?: string;
@ApiPropertyOptional({ enum: TeamStatus, default: TeamStatus.ACTIVE })
@IsOptional()
@IsEnum(TeamStatus)
status?: TeamStatus;
}
All API errors follow this schema:
{
"statusCode": 400,
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": ["field must be a string"],
"requestId": "uuid",
"timestamp": "2026-01-01T00:00:00.000Z"
}
| Decorator | Purpose |
|---|---|
@ApiTags('Tag') | Group endpoints by tag |
@ApiOperation({ summary }) | Endpoint description |
@ApiResponse({ status, description }) | Response documentation |
@ApiBearerAuth() | Mark as JWT-protected |
@ApiProperty({ description, example }) | Required field |
@ApiPropertyOptional({...}) | Optional field |
@ApiQuery({ name, required, enum }) | Query parameter |
@ApiParam({ name, description }) | Path parameter |
@ApiConsumes('multipart/form-data') | File upload endpoint |
Complete guide for the SE104_VLEAGUE React frontend — pages, services, components, auth flow, i18n, and patterns
Complete guide for testing patterns, test structure, CI pipeline, and development workflow for SE104_VLEAGUE
Complete guide for the SE104_VLEAGUE NestJS backend — modules, endpoints, Prisma schema, guards, interceptors, and patterns