Skip to content

Commit

Permalink
feat: modified swagger docs url and added in readme
Browse files Browse the repository at this point in the history
  - fixed event uid issue in seed data
  • Loading branch information
navneethkrish authored and madan-ideas2it committed Nov 14, 2024
1 parent 0a4f8a6 commit 3a6f0df
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,14 @@ Go to the parent folder:
$ yarn nx serve web-api
```

### API Documentation

The API documentation is available at the following URL:

[API Documentation](http://localhost:3000/api/docs)

Visit this link to explore the API endpoints, parameters, and responses.

### Production Mode

```sh
Expand Down
2 changes: 1 addition & 1 deletion apps/web-api/prisma/fixtures/pl-events.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const eventFactory = Factory.define<Omit<PLEvent, 'id'>>(
const endDate = new Date(startDate.getTime() + faker.datatype.number({ min: 1, max: 30 }) * 24 * 60 * 60 * 1000);

return {
uid: faker.datatype.uuid(),
uid: `uid_${sequence}`,
type: faker.helpers.arrayElement(['INVITE_ONLY', null]),
name: faker.company.name(),
description: faker.lorem.paragraph(),
Expand Down
2 changes: 1 addition & 1 deletion apps/web-api/src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export async function bootstrap() {
.addTag('PL')
.build();
const document = SwaggerModule.createDocument(app, config);
SwaggerModule.setup('api', app, document);
SwaggerModule.setup('api/docs', app, document);

// Sentry - Error Reporting
Sentry.init({
Expand Down

0 comments on commit 3a6f0df

Please sign in to comment.