Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rachamallayeswanthreddy/medicinepharamcyapi
Medicine-Controller project simplifies the management of medicines in a pharmacy setting, making it easier to add new medicines and keep existing ones up to date through a user-friendly API
https://github.com/rachamallayeswanthreddy/medicinepharamcyapi
java jdk maven mysql postman restful-api spring-boot
Last synced: 4 days ago
JSON representation
Medicine-Controller project simplifies the management of medicines in a pharmacy setting, making it easier to add new medicines and keep existing ones up to date through a user-friendly API
- Host: GitHub
- URL: https://github.com/rachamallayeswanthreddy/medicinepharamcyapi
- Owner: RachamallaYeswanthReddy
- License: mit
- Created: 2023-10-04T10:19:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-04T15:40:19.000Z (over 1 year ago)
- Last Synced: 2024-11-22T06:28:37.408Z (2 months ago)
- Topics: java, jdk, maven, mysql, postman, restful-api, spring-boot
- Language: Java
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Medicine Pharmacy API
## Introduction
This is a Medicine Pharmacy API developed using Spring Boot, Java, and MySQL. It allows you to manage medicines in a pharmacy system by providing endpoints for adding new medicines and updating existing ones.
- A SpringBoot REST API built for its [Client](https://github.com/RachamallaYeswanthReddy/Medicine-Controller.git)
## Prerequisites
Before you start using this API, make sure you have the following installed:
- Java Development Kit (JDK)
- Spring Boot
- MySQL Database
- Postman (for testing)
## Setup
1. Clone the repository:
bash
git clone https://github.com/RachamallaYeswanthReddy/Medicine-Controller.git
cd Medicine-Controller
2. Configure the MySQL database by editing the application.properties file in the src/main/resources directory. Update the database URL, username, and password according to your MySQL setup.
3. Build and run the application:
bash
./mvnw spring-boot:run
The API will be accessible at http://localhost:8080.
## API Endpoints
### Add Medicine
- **Endpoint:** POST /medicines
- **Request Body:**
json
{
"medicineName": "Paracetamol",
"price": 5.99,
"quantity": 200,
"description": "Common pain and fever medication"
}
- **Response:** Returns "true" if the medicine is successfully added, otherwise false.
### Update Medicine
- **Endpoint:** PUT /medicines/{medicineId}
- **Request Body:**
json
{
"medicineName": "Paracetamol",
"price": 5.99,
"quantity": 200,
"description": "Common pain and fever medication"
}
- **Response:** Returns the updated Medicine object.
## Usage
You can use Postman or any other API testing tool to interact with the endpoints.
1. Open Postman.
2. Create a new collection and add new request.
3. Set the request method (POST or PUT), URL (e.g., http://localhost:8080/medicines), and add the request body as described above.
4. Send the request to test the API.
### Follow the steps below
- Clone this repository
- Create a MySql database with the name medicine
- You can create the database with any name you like. Make sure to update the datasource url in application.properties
- If your datasource username and password are not the defaults username(root) and password(" ") , then update their values inapplication.properties
- Run the code given in the textfile mysql in the MYSQL Workbench
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details.
Please make sure to update your repository link in the clone URL and any other specific details in the README according to your project's requirements.