SpringBootRestAPI

Modelo Restapi - Boot de primavera + MongoDB

Descrição

Um modelo pronto para uso para a API REST usando o Spring-Boot-Microservices, MongoDB como banco de dados, integrado ao Codecov e Sonarqube, implantável para a nuvem. Este modelo pode ser conectado a qualquer aplicativo para iniciar a tarefa facilmente sem escrever tudo do zero.

Progresso da lista de tarefas

• Controladores de Rest e modelos usando o trampolim
• Configuração do MongoDB
• Travisci Build
• Integração Sonarqube
• Relatório de teste de Jacoco
• Autenticação JWT
• 80% e acima da cobertura de código (usando codecov ou CoverAlls)
• Implantação em nuvem

Começando

• Importe este projeto para o seu IDE favorito após o Fork e o check -out deste repositório.

Pré-requisito e instalação de etapas

• Obtenha uma instância em execução do MongoDB à qual você pode se conectar. Para mais informações sobre como começar o MongoDB, visite seu tutorial on -line.

• Comece criando um banco de dados de teste. Vou chamar de meu "REST_TUTORIAL" usando o seguinte comando no shell do MongoDB ou através de um gerenciador de banco de dados como o MongoDB Compass: use rest_tutorial;

• Crie uma coleção de amostras que mantenha dados sobre diferentes tipos de animais de estimação. Vamos criar a coleção com o seguinte comando: db.createCollection("pets");

• Depois que a coleção é criada, precisamos adicionar alguns dados! We can add data to the collection with the below query, you can add any number of data like this : db.pets.insertMany([ { "name" : "Spot", "species" : "dog", "breed" : "pitbull" }, { "name" : "Daisy", "species" : "cat", "breed" : "calico" }, { "name" : "Bella", "species" : "dog", "breed" : "australian shepard" } ]);

• Adicione o nome de autenticação MongoDB, nome de usuário e senha no Application.properties Se não houver autenticação quando você estiver executando localmente, também poderá remover essas propriedades deste arquivo.

• Crie as funções do usuário no banco de dados. As funções do usuário podem ser de "usuário, moderador ou administrador"

 db.roles.insertMany([
   { name: "ROLE_USER" },
   { name: "ROLE_MODERATOR" },
   { name: "ROLE_ADMIN" },
])

Executando os testes

Depois que o servidor é iniciado, sua primeira necessidade de registrar um usuário e fazer login como o usuário para obter um token.

Registro do usuário

Login de usuário

Depois de obter o token, você precisa passar esse token para todas as solicitações que você faz no back -end no Postman, selecione a seção "cabeçalho" e insira Authorization para a chave e
"Portador" para o valor

Você é livre para testar sua API como escolher. Use Postman para os testes abaixo:

getAllpets

getpetbyId

CreatePet

DeletePet

ModifyPetbyId

Uma vez feito com todos os testes, você pode fazer logout usando o endpoint /api/auth/logout

logout

Cobertura de código

Para a integração dos relatórios de cobertura de código, mostrei um exemplo usando o CodeCov e o CoverAlls, pois ambos são bastante populares e fáceis de integrar ao Travis.

• Codecov - Basta adicionar esta linha no .Travis.yml, que enviará o relatório Jacoco ao console CodeCov

• CoverAlls - Precisa adicionar o Plugin do CoverAlls e o caminho do relatório Jacoco no arquivo Build.gradle. Também precisa mudar em .Travis.yml em vez de codecov para usar o CoverAlls

Modelo de solicitação de problema

Are you up for your first Issue Request for this project !!! Awesome, mas, primeiro, analise o modelo de edição.md e use este modelo para enviar qualquer solicitação de problema.

Modelo de solicitação de puxar

Are you up for your first PR for this project !!! INCRÍVEL, mas, primeiro, passe pelo modelo de solicitação de tração.md e use este modelo para enviar seu PR.

Contribuindo

Leia contribuindo.md e código de conduta.md para obter detalhes sobre nosso código de conduta e o processo para enviar solicitações de puxar para nós.

Autores

• Gourav Rusiya