https://github.com/cuongndc9/rest-swagger

🚀🌳 Build a Rest API using Swagger.
https://github.com/cuongndc9/rest-swagger

103cuong node rest-api rest-swagger swagger swagger-ui

Last synced: 11 days ago
JSON representation

🚀🌳 Build a Rest API using Swagger.

• Host: GitHub
• URL: https://github.com/cuongndc9/rest-swagger
• Owner: cuongndc9
• Created: 2019-05-17T10:28:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-14T06:47:04.000Z (over 5 years ago)
• Last Synced: 2024-11-21T04:06:35.988Z (2 months ago)
• Topics: 103cuong, node, rest-api, rest-swagger, swagger, swagger-ui
• Language: JavaScript
• Homepage:
• Size: 126 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# rest-swagger

> 🚀🌳 Build a Rest API using Swagger.

![screenshot](images/screenshot.png)

## Quick start

### Install dependencies

```sh

$ yarn

```

### Run this project

```sh

$ yarn start

```

Go to [here](http://127.0.0.1:9000/docs) to view api documents.

## API

| Route            | HTTP method | Description                 |

|------------------|-------------|-----------------------------|

| /api/cats        | `GET`       | Get all the cats.           |

| /api/cats        | `POST`      | Create a cat.               |

| /api/cats/:catId | `GET`       | Get a single cat.           |

| /api/cats/:catId | `PUT`       | Update a cat with new info. |

| /api/cats/:catId | `DELETE`    | Delete a cat.               |