https://github.com/jlenon7/builders-test

🧪 Project developed in test for Platform Builders
https://github.com/jlenon7/builders-test

Last synced: 9 days ago
JSON representation

🧪 Project developed in test for Platform Builders

• Host: GitHub
• URL: https://github.com/jlenon7/builders-test
• Owner: jlenon7
• Created: 2021-07-19T14:18:52.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-29T17:24:13.000Z (over 1 year ago)
• Last Synced: 2024-10-04T23:41:20.468Z (3 months ago)
• Language: Java
• Size: 96.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Builders Test 🧪

> Project developed in test for Platform Builders

[![GitHub followers](https://img.shields.io/github/followers/jlenon7.svg?style=social&label=Follow&maxAge=2592000)](https://github.com/jlenon7?tab=followers)

[![GitHub stars](https://img.shields.io/github/stars/jlenon7/builders-test.svg?style=social&label=Star&maxAge=2592000)](https://github.com/jlenon7/builders-test/stargazers/)



  

  

  



`RESTFul API` using `Spring Boot`



## PROJECT

> Access the project [CLICKING HERE](http://joao.devopstests.com/api)

## ENDPOINTS

> All endpoints are well documented within the [InsomniaCollection.json](https://github.com/jlenon7/builders-test/blob/master/.github/InsomniaCollection.json) file

> and in [Swagger](http://joao.devopstests.com/swagger-ui.html)

| METHOD    | URI                    | NAME               |

| --------- | ---------------------  | -----------------  |

| GET       | api/v1/clients         | clients.index      |

| POST      | api/v1/clients         | clients.store      |

| GET       | api/v1/clients/:id     | clients.show       |

| PUT       | api/v1/clients/:id     | clients.update     |

| DELETE    | api/v1/clients/:id     | clients.delete     |

### Query search in clients.index

Pagination: `?page=0&limit=10`

Between ages: `?since_age=20&max_age=40`

### Content Negotiation

> All endpoints of this API has content negotiation between, xml, json and yaml.

Send `Content-Type: application/xml` Receives `Accept: application/json`

Send `Content-Type: application/json` Receives `Accept: application/xml`

Send `Content-Type: application/xml` Receives `Accept: application/x-yaml`

Send `Content-Type: application/x-yaml` Receives `Accept: application/json`

etc...

---

## Running project local

> First run an instance of MySQL, you can use this command to run with docker.

```bash

docker run --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=bancodedados -e MYSQL_PASSWORD=bancodedados -e MYSQL_DATABASE=mysql -d mysql

```

> Then build the project and run the tests using Maven

```bash

mvn clean package

```

> Then run the .jar file created by Maven

```bash

java -jar target/builders-test-0.1-SNAPSHOT.jar

```

---

## Running project with docker-compose

> First change the url of the database inside application.properties to builders-db instead of localhost



    



> Then run the project using docker-compose

```bash

docker-compose up -d --build

```

---

Made with 🖤 by [jlenon7](https://github.com/jlenon7) :wave: