https://github.com/rachamallayeswanthreddy/studentapi

Student API
https://github.com/rachamallayeswanthreddy/studentapi

java jdk maven postgresql postman restful-api spring-boot

Last synced: 25 days ago
JSON representation

Student API

• Host: GitHub
• URL: https://github.com/rachamallayeswanthreddy/studentapi
• Owner: RachamallaYeswanthReddy
• Created: 2023-10-03T09:22:14.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-05T17:52:29.000Z (about 1 year ago)
• Last Synced: 2024-09-30T13:04:58.695Z (about 1 month ago)
• Topics: java, jdk, maven, postgresql, postman, restful-api, spring-boot
• Language: Java
• Homepage:
• Size: 29.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# StudentAPI

## Overview

The Student API is a Java-based Spring Boot application designed to manage student information. It provides endpoints to add, retrieve, update, and delete student records, including details such as name, email, and department. This API is useful for educational institutions, allowing them to keep track of their students information efficiently.

## Prerequisites

Before you begin, ensure that you have the following prerequisites installed:

- **Java Development Kit (JDK) 11 or higher:** The project is developed using Java, so you need a compatible JDK installed on your machine. Here I used JDK 17.

- **IntelliJ IDEA (or any preferred IDE):** You can use any Java IDE, but IntelliJ IDEA is recommended for a smooth development experience.

- **Postman:** This tool will help you test the API endpoints and verify their functionality.

## Getting Started

To get started with the Student API, follow these steps:

1. **Clone the Repository:**

   git clone https://github.com/RachamallaYeswanthReddy/StudentAPI.git

2. **Open the Project in IntelliJ IDEA:**

   - Open IntelliJ IDEA.

   - Click on "File" -> "Open" and select the project folder.

## Configuration

The project's configuration can be found in the 'application.properties' file. You can adjust database settings, server ports, and other configuration options as needed.

## Running the Application

You have two options for running the Student API:

### Using IntelliJ IDEA:

1. Open the project in IntelliJ IDEA.

2. Locate the 'IntroApplication' class in the project structure.

3. Right-click on 'IntroApplication' and select "Run 'IntroApplication'".

### Using Command Line:

1. Navigate to the project directory in your terminal.

2. Run the following command:

   ./mvnw spring-boot:run

The application will start, and you will see log messages indicating that the server is up and running.

## Testing the API ( Recommended)

To test the Student API, you can use Postman or any similar API testing tool:

1. Open Postman.

2. Create a new request and set the request type (e.g., POST, GET , DELETE, PUT  ).

3. Enter the URL for the desired API endpoint (e.g., http://localhost:8011/api/v1/student/delete/12  , http://localhost:8011/api/v1/student/update/1 ).

4. Add any required headers, request parameters, or request body data according to the API documentation.

5. Click the "Send" button to make the request and view the API's response.

## Additional Notes

- If you encounter any issues or have questions about using the Student API, please feel free to reach out to me at [email protected].

- For more detailed information about the API endpoints and their usage, refer to the API documentation provided in the project's documentation folder.

## License

This project is open-source and available under the [MIT License](LICENSE). You are free to use, modify, and distribute this software according to the terms of the license.

'''

You can customize this README.md description further to provide specific details about your project, including any additional features, dependencies, or usage instructions.