feat(api): integrate Swagger UI for API documentation and add OpenAPI…

[coder7475]

Add Demo swagger specification for api-docs route

Summary by CodeRabbit

• New Features

  • Added interactive API documentation accessible at the /api-docs endpoint.
  • Introduced an OpenAPI specification describing the /hello endpoint, which returns a JSON greeting message.

• Chores

  • Updated dependencies to support API documentation features.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new OpenAPI specification file was added, defining a /hello endpoint. The Express app was updated to serve Swagger UI documentation at /api-docs using this spec. The package dependencies were updated to include swagger-ui-express, yamljs, and related TypeScript types, with no changes to existing APIs or exported entities.

Changes

Cohort / File(s)	Change Summary
OpenAPI Specification apps/express/openapi.json	Added OpenAPI 3.0.0 spec describing /hello GET endpoint returning a JSON greeting message.
Dependency Updates apps/express/package.json	Added swagger-ui-express, yamljs, and @types/swagger-ui-express to dependencies and devDependencies.
Swagger UI Integration apps/express/src/app.ts	Imported OpenAPI spec, set up Swagger UI at /api-docs using swagger-ui-express middleware.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ExpressApp
    participant SwaggerUI

    User->>ExpressApp: GET /api-docs
    ExpressApp->>SwaggerUI: Serve Swagger UI with OpenAPI spec
    SwaggerUI->>User: Rendered API documentation

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

A hop to /api-docs, what do I see?
Swagger UI shining, as clear as can be!
With "Hello, world!" in JSON delight,
The OpenAPI file makes endpoints bright.
Dependencies gathered, the docs now appear—
A rabbit’s proud leap, API docs are here! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0a447ca and d1b750a.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (3)

• apps/express/openapi.json (1 hunks)
• apps/express/package.json (2 hunks)
• apps/express/src/app.ts (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch swagger_config

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.