https://github.com/eliasnogueira/credito-api
Projeto alvo dos testes do livro Testes para uma API com Postman e RestAssured
https://github.com/eliasnogueira/credito-api
Last synced: 8 months ago
JSON representation
Projeto alvo dos testes do livro Testes para uma API com Postman e RestAssured
- Host: GitHub
- URL: https://github.com/eliasnogueira/credito-api
- Owner: eliasnogueira
- License: mit
- Created: 2020-02-11T11:12:26.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T04:57:17.000Z (over 2 years ago)
- Last Synced: 2025-02-01T15:11:25.590Z (8 months ago)
- Language: Java
- Homepage: https://leanpub.com/testes-api-postman-rest-assured-v1
- Size: 89.8 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Credito API
Este projeto foi criado como aplicacão alvo dos testes para o livro [Testes para uma API com Postman e RestAssured](https://leanpub.com/testes-api-postman-rest-assured-v1)
# Softwares necessários
Você precisará dos seguintes softwares para executar este aplicação:
* Java JDK 11+
* Maven configurado no seu classpath
# Sobre a aplicação
## Como inicializar a API
### Localmente
Após ter efetuado o clone do projeto:
1. Navegue até a pasta do projeto pelo Terminal / Prompt de Comando
2. Execute o seguinte comando: `mvn spring-boot:run`
3. Aguarde o seguinte texto aparecer: _Aplicação iniciada! Bons testes!_
#### Como alterar a porta padrão a porta
A porta padrão é a `8088`.
Se você deseja alterar a porta padrão para alguma outra de sua escolha, execute o seguinte comando, substituindo
o texto `` para uma porta não utilizada.
Alterando a porta executando a aplicação através do arquivo `.jar`
```shell
java -jar credit-api-VERSION.jar --server-port=8089
```
Alterando a porta executando a aplicação usando `mvn`
```shell
mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=
```
### Usando Docker
Você também pode usar Docker para acessae diretamente a aplicação.
1. Inicie o Docker no seu computador
2. Abra o seu Terminal / Prompt de Comando
3. Faca o download da imagem docker: `docker pull eliasnogueira/credito-api `
4. Execute o seguinte comando: `docker run --name credito-api -p 8088:8088 eliasnogueira/credito-api`
Você poderá acessar normalmente a aplicação.
Você pode parar a execução da aplicação executando `docker stop credito-api`, porque anteriormente atribuimos este nome
no comando de execução.
#### Como alterar a porta padrão a porta
A porta padrão é a `8088`.
Se você deseja alterar a porta padrão para alguma outra de sua escolha, substitua a primeira atribuição de porta no
comando `docker run`. A seguinda porta deve se manter `8088`.
No exemplo abaixo a porta for alterada para `8089`:
```
docker run --name credito-api -p 8089:8088 eliasnogueira/credito-api
```
## Como acessar a documentação (OpenAPI)
Após ter iniciado a aplicação acesse o seguinte link: http://localhost:8088/swagger-ui/index.html
# Quer ajudar?
Por favor, leia o [Guia de Contribuição](CONTRIBUTING.md)