vidhya03 / http-patch-jax-rs

A simple HTTP REST service web application also called as Person API

Home Page:http://http-patch-vidhya.1d35.starter-us-east-1.openshiftapps.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Person API

Build Status codecov License: MIT HitCount GitHub issues PRs Welcome

A simple HTTP REST service web application also called as Person API

Heads up

Development

  • checkout
  git clone https://github.com/vidhya03/http-patch-jax-rs.git
  • compile
  cd  http-patch-jax-rs.git
  mvn compile
  • Spotbugs SpotBugs is a program which uses static analysis to look for bugs in Java code.

    Spotbugs can be triggred via compile time.

  mvn -Pspotbugs compile

Spotbugs can also be check by using the below command.

  mvn -Pspotbugs spotbugs:check

Debug the spotbugs error via the following command.

  mvn -Pspotbugs spotbugs:gui

The above command will popup spotbugs errors in GUI like this spotbugs error view in GUI

Rest API testing using karate

  • To run test against production
  mvn test
  • To run test against local deployment
  mvn test -Dkarate.env=dev

and the HTML reports would be output to /target/surefire-reports/TEST-com.labkit.test.personapi.PersonApi.html karate test Report

Code Coverage using Cobertura

  • To run test and perform code coverage
  mvn cobertura:cobertura

and the HTML reports would be output to target/site/cobertura/index.html Cobertura Code Coverage Report

Code Coverage using Jacoco

  • To run test and perform code coverage
  mvn clean test -Pcoverage

and the HTML reports would be output to target/site/jacoco/index.html Jacoco Code Coverage Report

License

Credits

About

A simple HTTP REST service web application also called as Person API

http://http-patch-vidhya.1d35.starter-us-east-1.openshiftapps.com/

License:MIT License


Languages

Language:Java 93.5%Language:Gherkin 4.6%Language:JavaScript 1.2%Language:HTML 0.6%Language:Shell 0.1%