GouravRusiya30 / SpringBootRestAPI

A ready-to-use Template for Rest API using spring-boot-microservices, MongoDB as Database, Integrated with codecov and sonarqube, deployable to cloud.
https://gouravrusiya30.github.io/SpringBootRestAPI/
MIT License
37 stars 13 forks source link
bddmockito beginner-friendly codecov codecoverage coveralls good-first-issue gradle help-wanted jacoco microservices mongodb rest-api restapi-example sonarcloud springboot springboot-mongodb springboot-restapi-template springboot-sample springboot2 travis-ci

RestAPI Template - Spring Boot + MongoDB

License: MIT Travis Build Status sonar codecov Build status

contributions welcome Open Source Love PRs Welcome first-timers-only-friendly HitCount

Desciption

A ready-to-use Template for Rest API using spring-boot-microservices, MongoDB as Database, Integrated with codecov and sonarqube, deployable to cloud. This template can be plugged into any application to kickstart task easily without writing everything from scratch.

Task List Progress

Getting Started

Pre-requisite and Installing Steps

Running the tests

Once the server starts, your first need to register a user and login as that user to get a token.\

user registration
User login

Once you get the token, you need to pass that token for every request you make to the backend In the postman, select the "header" section and enter Authorization for the key and\ "Bearer " for the value

you are free to test your API however you choose. Use postman for the below tests :

getAllPets
getPetById
createPet
deletePet
modifyPetById

Once done with all the testing, you can logout using the endpoint /api/auth/logout

logout

Code Coverage

For code coverage reports integration, I have shown example using Codecov and Coveralls as both are pretty popular and easy to integrate with the travis.

Issue Request Template

Are you up for your first Issue Request for this project !!! Awesome but please first go through the ISSUE TEMPLATE.md and use this template to submit any issue request.

Pull Request Template

Are you up for your first PR for this project !!! Awesome but please first go through the PULL REQUEST TEMPLATE.md and use this template to submit your PR.

Contributing

Please read CONTRIBUTING.md and CODE OF CONDUCT.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors