Location de Maison API

The only thing better than a Maven archetype is a repo you can fork with everything already setup. Skip the documentation and just fork-and-code.

Resume

• The application have two user type's (hote/touriste).
• Provide an authentication and inscription for the users.
• The "hote" can manage his leasing's and send message to "touriste"
• the "touriste" can check the leasing catalogue, make his choice and proceed whith paypal payment.

Built With

• Maven - Dependency Management
• JDK - Java™ Platform, Standard Edition Development Kit
• Spring Boot - Framework to ease the bootstrapping and development of new Spring Applications
• MySQL - Open-Source Relational Database Management System
• git - Free and Open-Source distributed version control system

External Tools Used

• Postman - API Development Environment (Testing Docmentation)

Running the application locally

There are several ways to run a Spring Boot application on your local machine. One way is to execute the main method in the com.arc.sbtest.SBtemplateApplication class from your IDE.

• Download the zip or clone the Git repository.
• Unzip the zip file (if you downloaded one)
• Open Command Prompt and Change directory (cd) to folder containing pom.xml
• Open Eclipse
  • File -> Import -> Existing Maven Project -> Navigate to the folder where you unzipped the zip
  • Select the project
• Choose the Spring Boot Application file (search for @SpringBootApplication)
• Right Click on the file and Run as Java Application

Alternatively you can use the Spring Boot Maven plugin like so:

mvn spring-boot:run

URLs

URL	Method	Remarks
http://localhost:8080/api/location/deletelocation/101	DELETE	Delete a location by id
http://localhost:8080/api/location/choosen/1	GET	Select a location by id
http://localhost:8080/api/User/Insc	POST	User Inscription
http://localhost:8080/api/Message/MsgHote	GET	Get a hot Message
http://localhost:8080/api/location/best	GET	Get location with high rating

Documentation

• Postman Collection - online, with code auto-generated snippets in cURL, jQuery, Ruby,Python Requests, Node, PHP and Go programming languages
• Postman Collection - offline

Files and Directories

The project (a.k.a. project directory) has a particular directory structure. A representative project is shown below:

.
├── Spring Elements
├── src
│   └── main
│       └── java
│           ├── com.api
│           ├── com.api.controller
│           ├── com.api.model
│           ├── com.api.repository

├── src
│   └── main
│       └── resources
│           ├── application.properties
├── src
│   └── test
│       └── java
├── JRE System Library
├── Maven Dependencies
├── src
├── target
├── pom.xml

Resources

• My API Lifecycle Checklist and Scorecard
• HTTP Status Codes