https://github.com/irenaeus-xvi/restfull-api-back-end
Dockerizing a RESTful API for Managing Person Objects using nodejs & express js
https://github.com/irenaeus-xvi/restfull-api-back-end
docker express-js nodejs restfull-api
Last synced: 16 days ago
JSON representation
Dockerizing a RESTful API for Managing Person Objects using nodejs & express js
- Host: GitHub
- URL: https://github.com/irenaeus-xvi/restfull-api-back-end
- Owner: Irenaeus-XVI
- Created: 2023-04-30T00:11:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-07T04:27:37.000Z (almost 3 years ago)
- Last Synced: 2025-01-14T01:41:48.928Z (over 1 year ago)
- Topics: docker, express-js, nodejs, restfull-api
- Language: JavaScript
- Homepage: https://hub.docker.com/repository/docker/irenaeusxvi/restfull-api/general
- Size: 658 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dockerize a RESTful API for Managing Person Objects
This repository contains a RESTful API for managing person objects, built with Node.js and Express.js, and Dockerize for easy deployment and scalability.
## Prerequisites
Before you begin, make sure you have the following installed:
* Docker: https://docs.docker.com/get-docker/
## Technologies Used
The following technologies were used to build this project:
- Node.js
- Express.js
- Docker
## How to Run the Application in a Docker Container
To run the application in a Docker container, follow these steps:
1. pull the repository:
**docker pull irenaeusxvi/restfull-api**
2. Build the Docker image:
**docker build . -t irenaeusxvi/restfull-api -f app/Dockerfile**
2. Run the Docker container:
**docker run -p 8000:8000 irenaeusxvi/restfull-api**
**The `-p` option maps the host port `8000` to the container port `8000`.**
**This will start the API in a Docker container on `http://localhost:8000`.**
3. Open a web browser and navigate to `http://localhost:8000/persons` to access the API.
**You should see a message indicating that the API is running.**
4. For Stopping a container
**docker stop *{Container name in your machine}* **
## API Endpoints
The following API endpoints are available:
- `GET /api/persons` - get all persons
- `GET /api/persons/{:id}` - get person by ID
- `POST /api/persons` - create a new person
- `PUT /api/persons/{:id}` - update person by ID
- `DELETE /api/persons/{:id}` - delete person by ID
## For Testing(Recommended use Postman)
### To retrieve a list of all persons:
http://localhost:8000/persons
### To retrieve a single person by ID:
http://localhost:8000/persons/{id}
### To update a person by ID:
http://localhost:8000/persons/{id}
### To delete a person by ID:
http://localhost:8000/persons/{id}
## Conclusion
Dockerize a simple RESTful API for managing person objects using Node.js and Express.js is a straightforward process. By following the steps outlined in this README.md file, you should be able to Dockerize this API and run it in a Docker container on your local machine.