Skip to content

Fix Swagger Doc for Prod (Vercel) #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
otakmager merged 2 commits into from
May 7, 2026
Merged

Fix Swagger Doc for Prod (Vercel) #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75bb458
Fix: update docs swagger for prod
May 7, 2026
6b098b9
Merge branch 'main' of https://github.com/otakmager/be-cms into dev
May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The API will be available at `http://localhost:3000` (default).
## API Documentation

Once the server is running, you can access the API documentation (Swagger UI) at:
`http://localhost:3000/api-docs`
`http://localhost:3000/docs`

## Running Tests

Expand Down
4 changes: 2 additions & 2 deletions src/routes/routes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ import contactRouter from '../routes/contact.route';
import adminRouter from '../routes/admin.route';
import { notFoundHandler } from '../middleware/not-found.middleware';
import swaggerUi from 'swagger-ui-express';
import { swaggerSpec } from '../utils/swagger';
import { swaggerSpec, swaggerUiOptions } from '../utils/swagger';

const router = express.Router();

router.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
router.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec, swaggerUiOptions));

router.use('/', homeRouter);
router.use('/', authRouter);
Expand Down
12 changes: 12 additions & 0 deletions src/utils/swagger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,3 +203,15 @@ const options: swaggerJsdoc.Options = {
};

export const swaggerSpec = swaggerJsdoc(options);

export const swaggerUiOptions = {
explorer: true,
customCssUrl: 'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui.css',
customJs: [
'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui-bundle.js',
'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui-standalone-preset.js',
],
swaggerOptions: {
url: '/docs/json',
},
};
Loading