The document discusses a REST Assured framework developed by PSI to test REST APIs. The framework uses REST Assured to simplify testing REST services. Tests are run using Jenkins and results are reported through TestNG. The framework was developed using test-driven development and behavior-driven development approaches. It was deployed on AWS and integrates services like MongoDB, Redis, and load balancers.

1. Global IT Solutions
An ISO 9001:2015 & ISO/IEC 27001:2013
REST Assured utilized for
REST APIs
Quick Read
The client has developed a powerful platform to optimize
the marketing mix and campaign planning strategies
using smart, data-driven decisions in marketing, sales,
and pricing.

2. Solution Approach & Methodology
REST Assured is an open-source Java Domain-specific language (DSL) that makes testing REST services
simple. It simplifies things by eliminating the need to use boiler-plate code to test and validate complex
responses. It also supports XML and JSON Request/Responses.
We have created complete framework to test the service level test cases using REST Assured.
Jenkins TestNG
Test Scheduler/CI Tool Control Execution(parallel)
Log Files API Tests
Test Results
Execute Tests & Do
Assertions
Extent Reports
API Test- 1 API Test- 2 API Test- 3 API Test- N
Certificates
Excel Data
Config Files
DB Validations
REST Assured Framework Architecture
Context Summary
In presented case study the platform architecture uploads analytical data sets on MongoDB. To store
the data sets in cache, we have used Redis server. With the help of REST Assured, we have made asser-
tion for the REST calls.We have created the REST Assured on TDD as well as BDD architecture using
Cucumber.
Reporting has been done using JUnit/TestNG. For the CI, we have used GitLab pipelines and for CD, we
have used Jenkins Boxes. With every code commit from dev team, CI automatically get triggerd and
creates a pass/fail build for the same.
We have deployed API engines on AWS Load Balancers.

3. API testing tests logic tier directly and checks expected functionality, reliability, performance and security.
In the agile development world, requirements are changing during short release cycles frequently and GUI
tests are more difficult to be conducted according to those changes. Thus, API testing becomes critical to
test application logic.
Achievements
We have uploaded the test data files in Mongo Database and with the help of REST Assured, we asserted
the Web Services. On every code checking auto trigger of the build has been done on GitLab pipeline.
Key Highlights
1
2
3
4
5
Strategy:
It required a framework/library which helps in testing APIs easy in less time and we
chose the REST Assured Library. The codes were written considering below stated
rules
Single Responsibility:
- Each test has a single responsibility
- Explicit separation has advantages while we do black-box testing
High Level of Abstraction:
- The logic of a test should be written in a broad way
- All details such as sending request, creating request, dealing with IO should be done
via utility methods and not by inline methods
Re-usability:
Develop the class, methods etc. that can be re-used for the testing of other endpoints
of APIs
Documentation:
Add documentation and comments to describe the tests sufficiently
Deployed on AWS Infrastructure
CI is completed on GitLab pipeline
CD is conducted on Jenkins/Octopus
JUnit/TestNG reporting of the service Test Cases
Highly cohesive structure
Clubbed REST Assured with Cucumber for BDD
We have achieved TDD and BDD both development strategies using REST Assured

4. Project Highlights
Client Analytics & Marketing Leader
Location USA
Solution Domain Strategic Marketing
Project Duration 45 days
Team Size 2 members
About PSI
Pratham Software (PSI) is a global IT services company (with established ISO 9001:2015 & ISO/IEC
27001:2013 practices) providing software product development, consulting and outsourcing solutions to
enterprises worldwide. While providing a wide range of solutions, we focus on Outsourced Product Devel-
opment (OPD), Business Process Management (BPM), Application Development and Maintenance (AMD)
and Content Engineering. Our extensive experience in OPD helps us build strong relationships with Inde-
pendent Software Vendors (ISVs), as we work with them throughout the product development lifecycle. In
terms of technology and platform, we work across all major technologies such as Microsoft, Java and
Open source and have capabilities and experience in developing solutions for web, mobile, Cloud and
social media. For Enterprise customers, in addition to Process Automation, we also offer development
and support services in BI and DWH.
US Office: 21860, Via Regina, Saratoga, California 95070 USA | Ph:(408) 898-4846 | Fax: (408) 867-0666
India Development Center: G1-265-266, RIICO Industrial Area, EPIP, Sitapura, Jaipur 302022, India | Ph: (91)141-6690000
www.thePSI.com
All PSI products and services mentioned herein as well as their respective logos are trademarks or registered with PSI. All other product and service names mentioned are the
trademarks of their respective companies. Data contained in this document serves informational purposes only.The content is subject to change without notice. This content
is provided by PSI for informational purposes only, without representation or warranty of any kind, and PSI shall not be liable for errors or omissions with respect to the content.