The Notes Sharing REST API is a scalable Spring Boot REST API service designed for creating, reading, updating, deleting, and sharing notes in various formats, including PDFs, videos, and web links. This API supports comprehensive CRUD operations and advanced search functionality by title, department, field, or owner.
- CRUD Operations: Create, read, update, and delete notes.
- Format Support: Share notes in PDF, video, and web link formats using url.
- Advanced Search: Search notes by title, department, field, or owner.
- Scalable Architecture: Designed for scalability and performance.
- Spring Boot: Framework for building the REST API.
- Java: Primary programming language.
- MySQL: Database for storing notes.
- JPA/Hibernate: ORM for database operations.
-
Get All Notes
GET /api/notes/all
-
Get Note by ID
GET /api/notes/id/{id}
-
Get Note by Department
GET /api/notes/department/{department}
-
Get Note by Owner
GET /api/notes/owner/{owner}
-
Get Note by Title
GET /api/notes/title/{title}
-
Get Note by Field
GET /api/notes/field/{field}
-
Create Note
POST /api/notes/add
Request Body:
{ "title": "Sample Note", "contentUrl": "This is a sample note.", "contentType": "PDF", "owner": "John Doe", "department": "Engineering", "field": "Software Development" }
-
Update Note
PUT /api/notes/update/{id}
Request Body (update fields as needed):
{ "id":1, "title": "Updated Note Title", "contentUrl": "This is updated sample note.", "contentType": "PDF", "owner": "Jane Doe", "department": "IT", "field": "Data Science" }
-
Delete Note
DELETE /api/notes/delete/{id}
- Developer: Shiv Prakash Verma
- Email: shivprakashlps@gmail.com
- College: IIT Ropar