Repository files navigation

A RESTful API for sustainable waste management, providing information on waste categories, recycling tips, and disposal guidelines.

• Waste Categories Management: Add, update, retrieve, and delete waste categories

• Recycling Tips: Get actionable insights on how to recycle different materials

• Disposal Guidelines: Retrieve best practices for safe and sustainable disposal

• Spring Security Authentication: Simple and secure username/password authentication

• Role-Based Access Control: Different access levels for users and admins

• Soft Delete Functionality: Preserves data relationships while allowing "deletion"

• Performance Optimization:

  • Caching for improved response times
  • Rate limiting to prevent API abuse

• API Documentation: Swagger/OpenAPI documentation

• Monitoring: Application health metrics and performance monitoring

The API is deployed and accessible athttps://sustainablewastemanagementapi.onrender.com

Interactive API documentation is available at:https://sustainablewastemanagementapi.onrender.com/swagger-ui/index.html

• Java 17
• Spring Boot 3.x
• Maven 3.6+
• Spring Security
• H2 Database (for development)
• Swagger/OpenAPI
• Actuator & Micrometer (for monitoring)
• Postman (API Testing)

Clone the repository:

git clone https://github.com/ZannyM/SustainableWasteManagementAPI

Build the project:

mvn clean install

Run the application:

mvn spring-boot:run

Access the API at:

http://localhost:8080

Access the API documentation at:

http://localhost:8080/swagger-ui/index.html

The API uses Spring Security with basic authentication:

Can perform standard operations

• Username:user
• Password:password

Has access to all endpoints including admin operations

• Username:admin
• Password:admin

This API implements a soft delete approach:

• Records are not physically removed from the database
• Instead, they are marked as inactive with anactive flag
• This preserves data relationships and prevents constraint violations
• Only active records are returned by default in API responses

• Public endpoints: GET operations on waste categories, recycling tips, and disposal guidelines
• Protected endpoints: POST, PUT, DELETE operations (require authentication)
• Admin endpoints: Special operations for administrators only

• Application health:http://localhost:8080/actuator/health
• Metrics:http://localhost:8080/actuator/metrics
• Prometheus metrics:http://localhost:8080/actuator/prometheus

###Testing

• JUnit 5: Unit and integration testing framework
• Mockito: Mocking framework for isolating dependencies during tests
• Spring Boot Test: For comprehensive testing of Spring components-Swagger UI: For interactive API testing

Run Unit and Integration Tests:

mvn test

This project is licensed under the MIT License - see the LICENSE file for details.

Zanny Maholobela