fly.id is a Spring Boot-powered RESTful API designed to facilitate data management in travel applications.
- Java
- Spring Boot
- REST API
- travel
- airplane
- transaction
- ticket
- user
https://fly-id-1999ce14c36e.herokuapp.com
Programming Language: Java 17 (or relevant version)
Framework: Spring Boot (specify version, e.g., 3.0.x)
Dependencies:
- Spring Web
- Spring Data JPA
- Hibernate
- Lombok (and others as needed)
Database: PostgreSQL
Build Tool: Maven (or Gradle)
Deployment: Heroku
fly.id offers a comprehensive set of API endpoints for managing essential travel data:
- Airplanes: Create, retrieve, update, and delete information about aircraft.
- Transactions: Manage financial transactions related to bookings and purchases.
- Tickets: Process ticket issuance, cancellation, and modification.
- User Details: Securely store and manage user profiles and authorization.
- RESTful API: Standardized, easy-to-integrate API endpoints.
- CRUD Operations: Create, Read, Update, and Delete data securely.
- Authentication and Authorization: Secure user access with JWT authentication.
- Data Validation: Ensure data integrity with comprehensive validation rules.
- Error Handling: Informative error messages for troubleshooting.
- Java 17 (or relevant version) installed
- Maven (or Gradle) installed
- PostgreSQL database available
- Clone the repository:
git clone https://github.com/Synrgy-Academy-Final-Project/Backend.git - Install dependencies:
mvn install(or Gradle equivalent)
- Start the application:
mvn spring-boot:run(or Gradle equivalent) - Access the API documentation at http://localhost:8080/swagger-ui.html
Comprehensive API documentation is available through your Postman collection:
This collection provides detailed information on each API endpoint, including:
- Request methods (GET, POST, PUT, DELETE)
- Request and response body formats (JSON, XML)
- Authentication requirements
- Example usage scenarios
We welcome contributions to fly.id! Please refer to the CONTRIBUTING.md file for guidelines.
This project is licensed under the MIT License. See the LICENSE file for details.
- Consider showcasing API usage examples or integrating code snippets where relevant.
- Mention any community forums or channels for discussions and support.
- Briefly describe your maintenance plans for addressing issues and updates.