https://github.com/dhurtado714-itesm/nestjs-swagger

https://github.com/dhurtado714-itesm/nestjs-swagger

nestjs openapi swagger-ui

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/dhurtado714-itesm/nestjs-swagger
• Owner: DHurtado714-itesm
• Created: 2024-09-08T18:22:13.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-08T18:26:07.000Z (4 months ago)
• Last Synced: 2024-10-21T05:18:34.123Z (2 months ago)
• Topics: nestjs, openapi, swagger-ui
• Language: TypeScript
• Homepage:
• Size: 82 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🚀 NestJS Project with Swagger Documentation and Route Filtering

This project is built using [NestJS](https://nestjs.com/), a progressive Node.js framework for building efficient and scalable server-side applications. It integrates [Swagger](https://swagger.io/) for automatic API documentation generation and includes route filtering based on paths, allowing for the creation of multiple files depending on the route path.

## ✨ Features

- **NestJS Framework**: Utilizes NestJS for building robust, testable, and scalable server-side applications.

- **Swagger Integration**: 📝 Automatically generates interactive API documentation using Swagger.

- **Route Filtering by Paths**: 🚦 Supports route filtering and separation by paths.

- **Dynamic File Generation**: 🗂️ Capable of generating multiple files depending on the specified path.

## 📦 Getting Started

### ✅ Prerequisites

Ensure you have the following installed:

- [Node.js](https://nodejs.org/en/) (v14.x or later)

- [npm](https://www.npmjs.com/) (v6.x or later) or [yarn](https://yarnpkg.com/)

### 📥 Installation

1. Clone the repository:

```bash

git clone https://github.com/your-repo/nestjs-swagger-route-filter.git

cd nestjs-swagger-route-filter

```

2. Install the dependencies:

```bash

pnpm install

```

3. Start the application:

```bash

pnpm run start:dev

```

The server will start at `http://localhost:3000` by default.

## Special Thanks

@bujosa for the original filtering code.