https://github.com/tupizz/xy-inc
spring boot rest api playgroung
https://github.com/tupizz/xy-inc
java rest-api spring-boot swagger swagger-ui
Last synced: 2 months ago
JSON representation
spring boot rest api playgroung
- Host: GitHub
- URL: https://github.com/tupizz/xy-inc
- Owner: tupizz
- Created: 2019-03-22T04:21:11.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-26T01:15:57.000Z (about 6 years ago)
- Last Synced: 2025-02-09T14:47:16.452Z (4 months ago)
- Topics: java, rest-api, spring-boot, swagger, swagger-ui
- Language: Java
- Size: 56.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
DOCUMENTAÇÃO DO PROJETO
===========================================
## **ESTRUTURA DO BANCO**
Foram criados dois bancos local sendo um para a aplicação e outro para rodar os testes de integração/endpoints, com as seguintes URIs de conexão. Além disso, foi disponibilizado no arquivo `application.properties` uma url de conexão em um banco de dados as service online postgresql, caso não desejam criar uma database `xy-inc` local na porta 5433 (ou de sua preferência).
**Banco principal:** `jdbc:postgresql://localhost:5433/xy-inc`
**Banco de teste:** `jdbc:h2:mem:test`
**Posgresql as Service:** `jdbc:postgresql://ec2-184-73-153-64.compute-1.amazonaws.com:5432/dc6j2oppjdv26m`
Assim, a seguinte modelagem da entidade foi projetada:
name: String required,
x: Integer required,
y: Integer required,
## **DESCRIÇÃO DA API**
A porta 8080 está exposta, e a partir dela é possível acessar a API de resources:
- **GET**
- **Listagem:** Para consultar todos os recursos cadastrados no banco, basta acessar http://localhost:8080/poi
- **Encontrar POI's proximos:** A partir de http://localhost:8008/poi/near é possível listar todos os pois proximos a um determinado ponto levando em consideração uma thresold de distância, para isso envie como parâmetro na url os seguintes dados: x, y e d (distância máxima desejada para filtragem).
Por exemplo: `http://localhost:8008/poi/near?x=20&y=10&d=10`
Resposta:
```json
[
{
"id": 1,
"x": 27,
"y": 12,
"name": "Lanchonete"
},
{
"id": 3,
"x": 15,
"y": 12,
"name": "Joalheria"
},
{
"id": 5,
"x": 23,
"y": 6,
"name": "Supermercado"
},
{
"id": 6,
"x": 12,
"y": 8,
"name": "Pub"
}
]
```
- **POST**
- **Criação de novo POI:** A partir de http://localhost:8080/poi é possível criar um novo POI, como payload debe ser enviado um objeto JSON, como no exemplo:
```json
{
"x": 22,
"y": 17,
"name": "Estádio de futebol"
}
```
## EXECUTANDO O PROJETO
This application is packaged as a war which has Tomcat 8 embedded. No Tomcat or JBoss installation is necessary. You run it using the ```java -jar``` command.
* Make sure you are using JDK 1.8 and Maven 3.x (importante)
* You can build the project and run the tests by running ```mvn clean package```
* Once successfully built, you can run the service by one of these two methods:
```
java -jar -Dspring.profiles.active=test target/spring-boot-rest-example-0.5.0.war
or
mvn spring-boot:run -Drun.arguments="spring.profiles.active=test"
```
----
### To view Swagger 2 API docs
Run the server and browse to localhost:8080/swagger-ui.html