Skip to content

Commit

Permalink
Feat: Swagger added for the content api
Browse files Browse the repository at this point in the history
  • Loading branch information
@DevendraPPatil
DevendraPPatil committed Jun 12, 2024
1 parent 3cb345c commit eed2da8
Show file tree
Hide file tree
Showing 4 changed files with 882 additions and 6 deletions.
2 changes: 1 addition & 1 deletion package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"@nestjs/mongoose": "^10.0.0",
"@nestjs/platform-express": "^10.0.0",
"@nestjs/platform-fastify": "^10.0.5",
"@nestjs/swagger": "^7.1.17",
"@nestjs/swagger": "^7.3.1",
"axios": "^1.6.2",
"class-transformer": "^0.5.1",
"class-validator": "^0.14.0",
Expand Down
318 changes: 316 additions & 2 deletions src/controllers/collection.controller.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,79 @@ import {
import { collection } from 'src/schemas/collection.schema';
import { CollectionService } from 'src/services/collection.service';
import { FastifyReply } from 'fastify';
import { ApiTags } from '@nestjs/swagger';
import {
ApiBody,
ApiExcludeEndpoint,
ApiForbiddenResponse,
ApiOperation,
ApiParam,
ApiResponse,
ApiTags,
} from '@nestjs/swagger';

@ApiTags('collection')
@Controller('collection')
export class CollectionController {
constructor(private readonly CollectionService: CollectionService) {}
constructor(private readonly CollectionService: CollectionService) { }

@ApiBody({
description: 'Request body for storing data to collection',
schema: {
type: 'object',
properties: {
name: { type: 'string', example: 'Teacher-Teacher' },
description: { type: 'string', example: 'Teacher-Teacher' },
category: { type: 'string', example: 'Word' },
author: { type: 'string', example: 'Ekstep' },
language: { type: 'string', example: 'kn' },
status: { type: 'string', example: 'live' },
tags: { type: 'array', items: { type: 'string' }, example: [] },
},
},
})
@ApiResponse({
status: 201,
description: 'Success message when data is stored to the collection table',
schema: {
type: 'object',
properties: {
status: { type: 'string', example: 'success' },
data: {
type: 'object',
properties: {
name: { type: 'string', example: 'Teacher-Teacher' },
description: { type: 'string', example: 'Teacher-Teacher' },
category: { type: 'string', example: 'Word' },
author: { type: 'string', example: 'Ekstep' },
language: { type: 'string', example: 'kn' },
status: { type: 'string', example: 'live' },
tags: { type: 'array', items: { type: 'string' }, example: [] },
createdAt: { type: 'string', example: '2024-06-07T06:14:44.161Z' },
updatedAt: { type: 'string', example: '2024-06-07T06:14:44.161Z' },
_id: { type: 'string', example: '6662a5848946f51e15abb9fd' },
collectionId: { type: 'string', example: '7b762891-8337-46a6-8eb0-abfcdc5c7f35' },
__v: { type: 'number', example: 0 },
},
},
},
},
})
@ApiResponse({
status: 500,
description: 'Error while data is being stored to the collection',
schema: {
type: 'object',
properties: {
status: { type: 'string', example: 'error' },
msg: { type: 'string', example: 'Server error - error message' },
},
},
})
@ApiForbiddenResponse({ description: 'Forbidden.' })
@ApiOperation({
summary:
'Store collection data for adding the content with the reference of the colletion id',
})
@Post()
async create(@Res() response: FastifyReply, @Body() collection: collection) {
try {
Expand All @@ -35,6 +101,51 @@ export class CollectionController {
}
}


@ApiResponse({
status: 200,
description: 'Successfully retrieved items',
schema: {
type: 'object',
properties: {
status: { type: 'string', example: 'success' },
data: {
type: 'array',
items: {
type: 'object',
properties: {
_id: { type: 'string', example: '665ef5896e1219eb3d1a9b21' },
name: { type: 'string', example: 'Teacher-Teacher' },
description: { type: 'string', example: 'Teacher-Teacher' },
category: { type: 'string', example: 'Word' },
author: { type: 'string', example: 'Ekstep' },
language: { type: 'string', example: 'kn' },
status: { type: 'string', example: 'live' },
tags: { type: 'array', items: { type: 'string' }, example: [] },
createdAt: { type: 'string', example: '2024-06-04T11:07:02.300Z' },
updatedAt: { type: 'string', example: '2024-06-04T11:07:02.300Z' },
collectionId: { type: 'string', example: '58009c39-fd86-45a5-bc32-9638a8198521' },
__v: { type: 'number', example: 0 },
},
},
},
},
},
})
@ApiResponse({
status: 500,
description: 'Error while retrive the data from collection',
schema: {
type: 'object',
properties: {
status: { type: 'string', example: 'error' },
msg: { type: 'string', example: 'Server error - error message' },
},
},
})
@ApiOperation({
summary: 'Get all data from the collection'
})
@Get()
async fatchAll(@Res() response: FastifyReply) {
try {
Expand All @@ -47,7 +158,56 @@ export class CollectionController {
});
}
}


@ApiParam({
name: 'language',
example: 'tn',
})
@ApiResponse({
status: 200,
description: 'Successfully retrieved the collection data for the selected language',
schema: {
type: 'object',
properties: {
status: { type: 'string', example: 'success' },
data: {
type: 'array',
items: {
type: 'object',
properties: {
_id: { type: 'string', example: '665ef5896e1219eb3d1a9b21' },
name: { type: 'string', example: 'Teacher-Teacher' },
description: { type: 'string', example: 'Teacher-Teacher' },
category: { type: 'string', example: 'Word' },
author: { type: 'string', example: 'Ekstep' },
language: { type: 'string', example: 'kn' },
status: { type: 'string', example: 'live' },
tags: { type: 'array', items: { type: 'string' }, example: [] },
createdAt: { type: 'string', example: '2024-06-04T11:07:02.300Z' },
updatedAt: { type: 'string', example: '2024-06-04T11:07:02.300Z' },
collectionId: { type: 'string', example: '58009c39-fd86-45a5-bc32-9638a8198521' },
__v: { type: 'number', example: 0 },
},
},
},
},
},
})
@ApiResponse({
status: 500,
description: 'Error while retrive the data from collection',
schema: {
type: 'object',
properties: {
status: { type: 'string', example: 'error' },
msg: { type: 'string', example: 'Server error - error message' },
},
},
})
@ApiOperation({
summary: 'Get all data from the collection with the specific language'
})
@Get('/bylanguage/:language')
async fatchByLanguage(
@Res() response: FastifyReply,
Expand All @@ -64,6 +224,51 @@ export class CollectionController {
}
}


@ApiParam({
name: 'id',
example: '65717aea18da2cbda941cee2',
})
@ApiResponse({
status: 200,
description: 'Successfully retrieved collection data using collection id',
schema: {
type: 'object',
properties: {
collection: {
type: 'object',
properties: {
_id: { type: 'string', example: '6662a5848946f51e15abb9fd' },
name: { type: 'string', example: 'Teacher-Teacher' },
description: { type: 'string', example: 'Teacher-Teacher' },
category: { type: 'string', example: 'Word' },
author: { type: 'string', example: 'Ekstep' },
language: { type: 'string', example: 'kn' },
status: { type: 'string', example: 'live' },
tags: { type: 'array', items: { type: 'string' }, example: ['ASR'] },
createdAt: { type: 'string', example: '2024-06-07T06:14:44.161Z' },
updatedAt: { type: 'string', example: '2024-06-07T06:14:44.161Z' },
collectionId: { type: 'string', example: '7b762891-8337-46a6-8eb0-abfcdc5c7f35' },
__v: { type: 'number', example: 0 },
},
},
},
},
})
@ApiResponse({
status: 500,
description: 'Error while retrive the data from collection',
schema: {
type: 'object',
properties: {
status: { type: 'string', example: 'error' },
msg: { type: 'string', example: 'Server error - error message' },
},
},
})
@ApiOperation({
summary: 'Get the collection data for collection id'
})
@Get('/:id')
async findById(@Res() response: FastifyReply, @Param('id') id) {
const collection = await this.CollectionService.readById(id);
Expand All @@ -72,6 +277,70 @@ export class CollectionController {
});
}


@ApiParam({
name: 'id',
example: '65717aea18da2cbda941cee2',
})
@ApiBody({
description: 'Request body for creating a new item',
schema: {
type: 'object',
properties: {
name: { type: 'string', example: 'எழுத்துக்கள்' },
description: { type: 'string', example: 'ASAR Set எழுத்துக்கள்' },
category: { type: 'string', example: 'Char' },
author: { type: 'string', example: 'ASER' },
language: { type: 'string', example: 'ta' },
status: { type: 'string', example: 'live' },
tags: { type: 'array', items: { type: 'string' }, example: ['ASER', 'set1', 'm1'] },
createdAt: { type: 'string', example: '2023-12-18T10:53:49.787Z' },
updatedAt: { type: 'string', example: '2023-12-18T10:53:49.788Z' },
collectionId: { type: 'string', example: '94312c93-5bb8-4144-8822-9a61ad1cd5a8' },
__v: { type: 'number', example: 0 },
},
},
})
@ApiResponse({
status: 200,
description: 'Successfully update the collection data using collection id',
schema: {
type: 'object',
properties: {
collection: {
type: 'object',
properties: {
_id: { type: 'string', example: '6662a5848946f51e15abb9fd' },
name: { type: 'string', example: 'Teacher-Teacher' },
description: { type: 'string', example: 'Teacher-Teacher' },
category: { type: 'string', example: 'Word' },
author: { type: 'string', example: 'Ekstep' },
language: { type: 'string', example: 'kn' },
status: { type: 'string', example: 'live' },
tags: { type: 'array', items: { type: 'string' }, example: ['ASR'] },
createdAt: { type: 'string', example: '2024-06-07T06:14:44.161Z' },
updatedAt: { type: 'string', example: '2024-06-07T06:14:44.161Z' },
collectionId: { type: 'string', example: '7b762891-8337-46a6-8eb0-abfcdc5c7f35' },
__v: { type: 'number', example: 0 },
},
},
},
},
})
@ApiResponse({
status: 500,
description: 'Error while retrive the data from collection',
schema: {
type: 'object',
properties: {
status: { type: 'string', example: 'error' },
msg: { type: 'string', example: 'Server error - error message' },
},
},
})
@ApiOperation({
summary: 'update the collection data using collection id'
})
@Put('/:id')
async update(
@Res() response: FastifyReply,
Expand All @@ -84,6 +353,51 @@ export class CollectionController {
});
}


@ApiParam({
name: 'id',
example: '65717aea18da2cbda941cee2',
})
@ApiResponse({
status: 200,
description: 'The item has been successfully deleted.',
schema: {
type: 'object',
properties: {
deleted: {
type: 'object',
properties: {
_id: { type: 'string', example: '6662a5848946f51e15abb9fd' },
name: { type: 'string', example: 'எழுத்துக்கள்' },
description: { type: 'string', example: 'ASAR Set எழுத்துக்கள்' },
category: { type: 'string', example: 'Char' },
author: { type: 'string', example: 'ASER' },
language: { type: 'string', example: 'kn' },
status: { type: 'string', example: 'live' },
tags: { type: 'array', items: { type: 'string' }, example: ['ASER', 'set1', 'm1'] },
createdAt: { type: 'string', example: '2023-12-18T10:53:49.787Z' },
updatedAt: { type: 'string', example: '2023-12-18T10:53:49.788Z' },
collectionId: { type: 'string', example: '94312c93-5bb8-4144-8822-9a61ad1cd5a8' },
__v: { type: 'number', example: 0 },
},
},
},
},
})
@ApiResponse({
status: 500,
description: 'Error while deleting the data from collection',
schema: {
type: 'object',
properties: {
status: { type: 'string', example: 'error' },
msg: { type: 'string', example: 'Server error - error message' },
},
},
})
@ApiOperation({
summary: 'delete the collection data using collection id'
})
@Delete('/:id')
async delete(@Res() response: FastifyReply, @Param('id') id) {
const deleted = await this.CollectionService.delete(id);
Expand Down
Loading

0 comments on commit eed2da8

Please sign in to comment.