https://github.com/e22m4u/routing-controllers-swagger-example

A simple REST API example with class-based controllers and Swagger documentation.
https://github.com/e22m4u/routing-controllers-swagger-example

api documentation express openapi rest routing-controllers swagger

Last synced: 4 days ago
JSON representation

A simple REST API example with class-based controllers and Swagger documentation.

• Host: GitHub
• URL: https://github.com/e22m4u/routing-controllers-swagger-example
• Owner: e22m4u
• License: mit
• Created: 2024-05-04T11:33:39.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2025-01-06T22:13:26.000Z (10 days ago)
• Last Synced: 2025-01-06T23:18:26.731Z (10 days ago)
• Topics: api, documentation, express, openapi, rest, routing-controllers, swagger
• Language: TypeScript
• Homepage:
• Size: 2.4 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A demo project showing how to build a REST API using

[routing-controllers](https://github.com/typestack/routing-controllers)

with integrated Swagger documentation powered by

[@e22m4u/ts-openapi](https://github.com/e22m4u/ts-openapi)

## Getting Started

1. Clone the repository:

```bash

git clone https://github.com/e22m4u/routing-controllers-swagger-example

cd routing-controllers-swagger-example

```

2. Install dependencies:

```bash

npm install

```

3. Start the server:

```bash

npm start

```

4. Access the Swagger UI documentation at

[http://localhost:3000/explorer](http://localhost:3000/explorer)

## License

This project is licensed under the MIT License.