Documentação das rotas | Código de conduta | Como contribuir | Histórico de alterações
Para iniciar o ServeRest execute o seguinte comando no terminal:
npx serverest@latest
Não é preciso fazer instalação com npm install
antes da execução.
Você também pode executar o ServeRest com o docker, utilizando o seguinte comando no terminal:
docker run -p 3000:3000 paulogoncalvesbh/serverest:latest
ServeRest permite o estudo de:
- Verbos GET, POST, PUT e DELETE
- Autenticação no header
- Boas práticas de segurança
- Query string
- Contrato
- Requisições aninhadas
Acesse serverest.js.org para ter acesso a documentação de todas as rotas, verbos, contratos e respostas possíveis.
A documentação é aberta automaticamente ao iniciar o ServeRest. Para evitar o início automático envie o comando npx serverest --nodoc
.
Para visualizar as configurações que são possíveis de serem feitas execute o comando:
npx serverest -h
Por default, o ServeRest irá fazer as seguintes alterações no cabeçalho, que podem ser desabilitadas com npx serverest --nosec
:
Cabeçalhos adicionados:
Strict-Transport-Security: max-age=15552000; includeSubDomains
X-Content-Type-Options: nosniff
X-DNS-Prefetch-Control: off
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
Cabeçalho removido:
X-Powered-By: Express
Utilize esse comportamento nos seus testes, validando a presença/ausência desses cabeçalhos.
Para saber mais leia o checklist de segurança de API
Os repositórios abaixo são bons exemplos de automação com boas práticas, com CI configurada e que consome o ServeRest.
- Java > Automação com REST-Assured e Junit - Lucas Fraga
- JS > Automação com Supertest, Mocha e Chai - Paulo Gonçalves
Adicione ao README.md do seu repositório o badge do Serverest e demonstre seu apoio ao projeto.
[![Badge ServeRest](https://img.shields.io/badge/API-ServeRest-green?style=for-the-badge)](https://github.com/PauloGoncalvesBH/ServeRest/)
![]() |
![]() |
![]() |
Sua empresa (ou projeto) utiliza e quer constar na lista? Abra uma issue informando o nome dela.
Obrigado a essas pessoas incríveis (emoji key):
Leandro Muto 📖 🚇 |
Felipe Rodrigues 🚇 |
Lucas Amaral 📢 🐛 📖 |
lucas.fraga 🤔 🐛 |
bruno batista 🤔 |
Elias Reis 🚧 🚇 |
gabriel-pinheiro 💻 🤔 |
Rafael Gomes 🚇 |
Diego Bandeira 🚇 |
Este projeto segue a especificação de all-contributors. Contribuições de qualquer tipo são bem-vindas!