root
52 lines
1.3 KiB
YAML
52 lines
1.3 KiB
YAML
openapi: 3.0.3
|
|
info: { title: Class API, version: 1.0.0 }
|
|
servers: [ { url: https://your-domain.com/api/v1 } ]
|
|
tags: [ { name: Classes } ]
|
|
security: [ { bearerAuth: [] } ]
|
|
|
|
paths:
|
|
/classes:
|
|
get:
|
|
tags: [Classes]
|
|
summary: List all classes
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
schema: { type: integer, default: 1 }
|
|
- in: query
|
|
name: per_page
|
|
schema: { type: integer, default: 20 }
|
|
- in: query
|
|
name: grade
|
|
schema: { type: string }
|
|
- in: query
|
|
name: teacher_id
|
|
schema: { type: integer }
|
|
responses:
|
|
"200": { description: Classes retrieved successfully }
|
|
|
|
/classes/{id}:
|
|
get:
|
|
tags: [Classes]
|
|
summary: Get class details by ID
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema: { type: integer }
|
|
responses:
|
|
"200": { description: Class details retrieved }
|
|
"404": { description: Class not found }
|
|
|
|
/classes/{id}/students:
|
|
get:
|
|
tags: [Classes]
|
|
summary: Get students enrolled in a specific class
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema: { type: integer }
|
|
responses:
|
|
"200": { description: Students retrieved }
|