https://github.com/abubacar-dev/node-api

Simple node api no framework using native node modules and using local database
https://github.com/abubacar-dev/node-api

api api-rest database http http-package javascript node node-js nodejs

Last synced: 16 days ago
JSON representation

Simple node api no framework using native node modules and using local database

• Host: GitHub
• URL: https://github.com/abubacar-dev/node-api
• Owner: abubacar-dev
• License: mit
• Created: 2024-09-04T13:52:42.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-20T08:58:31.000Z (about 2 months ago)
• Last Synced: 2024-10-15T02:25:00.112Z (about 1 month ago)
• Topics: api, api-rest, database, http, http-package, javascript, node, node-js, nodejs
• Language: JavaScript
• Homepage:
• Size: 499 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node API

Simple node api no framework using native node modules and using local json database

## Reference

 - [Mussinady_dev](https://youtube.com/@abubacar_dev)

## API Documentation

To test this project run:

```bash

npm run dev

```

#### Return all users

`GET http://localhost:3333/users`

#### Return filtered user

`GET http://localhost:3000/users?search=${name}`

| Parameter   | Type       | Description                                   |

| :---------- | :--------- | :------------------------------------------ |

| `name`      | `string` | **Mandatory**. |

#### Create new user

`POST http://localhost:3333/users`

```json 

    {

        "name": "Jonh Doe",

        "email": "[email protected]"

    }

```

#### Update user

`PUT http://localhost:3333/users/${ID-UUID}`

```json 

    {

        "name": "Jonh Doe Doe",

        "email": "[email protected]"

    }

```

| Parameter   | Type       | Description                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Mandatory**. |

#### Delete user

`DELETE http://localhost:3333/users/${ID-UUID}`

| Parameter   | Type       | Description                                   |

| :---------- | :--------- | :------------------------------------------ |

| `id`      | `string` | **Mandatory**. |

## Appendix

- node version require > v16 (LTS)

## Autor

- [@mussinady-abubcar](https://www.github.com/mussinady-abubcar)

## Tags

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)

## Demonstration

![](.github/demostration-api.gif)

 Developed with ❤️ by Mussinady Abubacar