Skip to content

Commit 0fac870

Browse files
PauloGoncalvesBHPauloGoncalvesBH
committed
feat: mover ambiente de api.serverest.dev para serverest.dev e atualizar documentação
1 parent 3afcdd1 commit 0fac870

19 files changed

+17797
-1026
lines changed

‎.github/workflows/continuous_delivery.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,5 +101,5 @@ jobs:
101101
known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
102102
- name: Release on api.serverest.dev
103103
run: |
104-
git remote add umbler ssh://[email protected]:9922/jnydrgre/api-serverest-dev.git
104+
git remote add umbler ssh://[email protected]:9922/jnydrgre/serverest-dev.git
105105
git push umbler trunk:trunk --no-verify --force

‎.github/workflows/deploy-docs-serverest-dev.yml‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎.releaserc.js‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,9 @@ module.exports = {
8181
['@semantic-release/commit-analyzer', {
8282
releaseRules: [
8383
{ scope: 'no-release', release: false },
84-
{ type: 'docs', scope: 'readme', release: 'patch' }
84+
{ scope: 'patch', release: 'patch' },
85+
{ type: 'docs', scope: 'readme', release: 'patch' },
86+
{ type: 'docs', scope: 'serverest', release: 'patch' }
8587
]
8688
}],
8789
['@semantic-release/release-notes-generator', {

‎README.md‎

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
<h1 align="center">ServeRest</h1>
33

4-
<i><h4 align="center">Servidor REST local de forma rápida e simples para estudo de testes de API</h4></i>
4+
<i><h4 align="center">Servidor REST para estudo de testes de API</h4></i>
55

66
<p align="center">
77
<a href="https://npmjs.com/package/serverest"><img alt="serverest version" src="https://img.shields.io/npm/v/serverest?style=for-the-badge"></a>
@@ -19,45 +19,49 @@
1919
</p>
2020

2121
_ServeRest_ permite o estudo de:
22-
- Verbos *GET, POST, PUT* e *DELETE*
22+
- Verbos *GET, POST, PUT* e *DELETE* com persistência de dados
2323
- Autenticação no header
24-
- Boas práticas de segurança
2524
- Query string
26-
- Contrato
27-
- Requisições aninhadas
25+
- Teste de schema json
2826

29-
<b><i><h3 align="center">Acessse <https://api.serverest.dev> para ter acesso às rotas disponibilizadas pelo ServeRest</h3></i></b>
27+
<b><h2 align="center">Ambientes disponíveis</h2></b>
3028

31-
## Documentação das rotas
29+
<table align="center">
30+
<tr>
31+
<td align="center">Online em serverest.dev<br/><a href="#online"><img alt="Texto serverest.dev" src="https://user-images.githubusercontent.com/29241659/97096352-49b1b380-1641-11eb-9b0a-5bb72e1b3882.png" height="80"></a></td>
32+
<td align="center">Local com NPM<br/><br/><a href="#localmente-com-npm"><img alt="Logo do NPM" src="https://user-images.githubusercontent.com/29241659/97096283-4bc74280-1640-11eb-920a-1c145b0c39d4.png" height="60"></a></td>
33+
<td align="center">Local com docker<br/><a href="#localmente-com-docker"><img alt="Logo do Docker" src="https://user-images.githubusercontent.com/29241659/97096274-1cb0d100-1640-11eb-9e5e-3f2d57376e63.png" height="100"></a></td>
34+
</tr>
35+
</table>
3236

33-
Acesse **<https://serverest.dev>** para visualizar a documentação de todas as rotas, verbos, contratos e respostas possíveis.
37+
<p align="center">
38+
<img alt="Print do ServeRest iniciado no terminal" src="https://user-images.githubusercontent.com/29241659/97097145-fa24b500-164b-11eb-9a1f-f9cae275ec98.png" height="124">
39+
</p>
3440

35-
<details><summary><i>Abra para ver imagem resumida das rotas disponíveis</i></summary>
41+
## Consumindo o ServeRest
3642

37-
<img alt="Lista de rotas disponibilizdas pelo ServeRest" src="https://user-images.githubusercontent.com/29241659/83936398-ba8f2680-a799-11ea-8689-dea126b74874.png" height="700">
43+
O ServeRest está disponível de forma [online](https://serverest.dev), no [npm](https://www.npmjs.com/package/serverest) e no [docker](https://hub.docker.com/r/paulogoncalvesbh/serverest/).
3844

39-
---
45+
Todas essas opções possuem as mesmas rotas, regras, dados pré-cadastrados e documentação. Escolha a melhor opção para você.
4046

41-
</details>
47+
No ambiente online os dados cadastrados são removidos diariamente, enquanto que no local basta reiniciar o ServeRest.
4248

43-
## Executar o ServeRest localmente
49+
Prefira a opção de ambiente local caso precise que os dados não sejam alterados por outro usuário.
4450

45-
É possível utilizar de forma local em _localhost:3000_, o que pode ser útil caso precise que os dados não sejam alterados por outros usuários.
51+
### Online
4652

47-
<p align="center">
48-
<img alt="Print do ServeRest iniciado no terminal" src="https://user-images.githubusercontent.com/29241659/96160448-5bca7e00-0eec-11eb-94d7-8222311e34c4.png" height="190">
49-
</p>
53+
Acesse <https://serverest.dev> para visualizar a documentação e as rotas disponíveis.
5054

51-
### Utilizando NPM
55+
> Essa é a melhor opção para quem não possui NPM e Docker na máquina ou não quer preocupar em gerenciar ambiente.
56+
57+
### Localmente com NPM
5258

5359
Execute o seguinte comando no terminal:
5460

5561
```sh
5662
npx serverest@latest
5763
```
5864

59-
> Não é preciso fazer instalação com `npm install` antes da execução.
60-
6165
<details><summary><i>Abra para ver detalhes de configuração do ServeRest com NPM</i></summary>
6266

6367
## Configuração
@@ -93,7 +97,7 @@ Utilize esse comportamento nos seus testes, validando a presença/ausência dess
9397

9498
</details>
9599

96-
### Utilizando Docker
100+
### Localmente com docker
97101

98102
Execute o seguinte comando no terminal:
99103

@@ -103,11 +107,11 @@ docker run -p 3000:3000 paulogoncalvesbh/serverest:latest
103107

104108
### Executando versão específica
105109

106-
Em ambos os comandos você sempre utilizará a última versão disponível. Caso queira usar uma versão específica basta substituir o `latest` pela versão desejada.
110+
Em ambos os comandos de subida de ambiente local será utilizado a última versão disponível. Caso queira usar uma versão específica basta substituir o `latest` pela versão desejada.
107111

108112
Você pode encontrar as versões disponíveis na [lista de tags no Docker Hub](https://hub.docker.com/r/paulogoncalvesbh/serverest/tags) e na [lista de versões do NPM](https://www.npmjs.com/package/serverest).
109113

110-
## Exemplo de automação
114+
## Exemplos de automação
111115

112116
Os repositórios abaixo são bons exemplos de automação com boas práticas, com CI configurada e que consome o ServeRest.
113117

‎docs/CNAME‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)