Automating and Testing a REST API
Automating and Testing a REST API
A Case Study in API testing using: Java, REST Assured, Postman, Tracks, cURL and HTTP Proxies
About the Book
Have you ever wished that you had a worked example of how to test a REST API? Not just automate the API, but how to interact with it, using command line and GUI tools, to support your manual interactive testing. Then take your testing forward into automating the API?
That's what this book provides. A step by step case study covering:
- How to read the REST API documentation.
- How to tell if the application is using the API.
- How to interact with the API from the command line with cURL.
- Automating with BASH and Windows Command Line.
- Sending API requests through an HTTP Proxy so you can see in detail the requests and responses.
- How to use HTTP Proxies to create data in the application through Fuzzing.
- Postman REST API GUI tool.
- Automate 'under the GUI' parts of the application that don't have an API.
- Automate the API with Java using REST Assured.
- Build abstraction code to make your automated efforts readable and maintainable.
- JSON and XML parsing with Serialization and Deserialization.
The book is fully supported by executable code which you can find on GitHub, and the support page for the book has sample videos showing some of the early steps in the case study in detail.
By working through this case study you will be able to interact with an API from the command line, GUI tools, HTTP messages in Proxies and with Java code.
Over the last few years, the Author has used the Open Source Tracks application as an example testing target to teach: Technical Web Testing, Automating GUIs and REST API Testing.
This book collates the preparatory work and teaching from the REST API workshops. The code from the workshops is included: for creating users, generating random data, testing basic API calls with PUT, GET, POST and DELETE.
Also the early steps of exploring and investigating the API interactively to support manual technical testing are explained in depth.
Table of Contents
- Introduction
-
Introduction to APIs
- What Is a Web Application?
- Google Is an Example of a Web Application
- What Is an API?
- What Is an HTTP Request?
- What Is a URL?
- What Are HTTP Verbs?
- What Is an HTTP Response?
- What Is an HTTP Status Code?
- What Are Payloads?
- What Is JSON?
- What Is XML?
- What Are HTTP Headers?
- What Is Authentication?
- What Is REST?
- What Tools Are Used for Accessing an API?
- Example APIs
- Recommended Reading
- Summary
-
Introducing Tracks Case Study
- Support Page
- How to Use This Case Study
- Source Code Location
- Case Study Contents Overview
- Why Test Tracks?
- What Is Tracks and GTD?
- Summary
-
Installing Tracks
- Official Tracks Install
- Pre-Built Virtual Machines
- Using Virtual Machines
- Summary
-
A Tour of Tracks
- Why Learn the GUI If We Are Testing the API?
- Login
- Home Screen
- Starred Screen
- Projects
- Admin
- Basic Functions to Use and Check in the API
- Summary
-
The Tracks REST API
- What Is a REST API?
- Tracks REST API Documentation
- API Doc Examples
- General HTTP REST Return Codes
- Summary
-
Using a Proxy to View GUI Traffic
- Why?
- How?
- Viewing Traffic
- Implications
- Summary
-
Using a Proxy and Fuzzer to Create Users
- Tools
- Capture and Resend the Create User Request
- We Learned
- Using OWASP ZAP Proxy
- Capture Traffic in ZAP and Use the Fuzzer
- Multiple Users Created
- Quick Tip - Creating Data in a Spreadsheet
- Summary
-
Case Study Example Using cURL on Tracks
- What Is cURL?
- Case Study Details
- Installing cURL
- Reading the Examples in Tracks Documentation
- Try the Tracks API Examples
-
Tracks
GET
API Calls - Adding Data
- Amending Data
- Deleting Data
- Additional References
- Summary
-
Exploring the Tracks API with cURL Through a Proxy
- Using a Proxy with cURL
- For Debugging
- For Exploration
- For Simple Scope Coverage
- Summary
- cURL Summary
-
Exploring Tracks API with Postman REST Client
- The GUI
- Issue Requests
- Postman Collections
- Environment Variables
- Authentication
- Using Postman Through a Proxy
- Recreate cURL Requests in Postman
- Summary
-
How to Use the Source Code
- Source Code Location
- How to Use the Source Code
- Summary
-
Starting to Automate
- Why Explore First?
- Choosing a Java Library
- REST Assured Overview
- REST Assured Related Reading
- Summary
-
The Case Study Overview - Testing Tracks v 2.3.0
- The Tools
- Code Location
- The Approach
- What I Automated
- Summary
-
The Case Study Creating Users with ‘App as API’
- Creating a User In Tracks via the API
- Does This Mean We Have to Stop Automating Here?
- How to Create a User
- ‘App as API’
- Investigating How to Treat the APP as API
- What Requests Do I Need?
- How Do We Do That?
-
TracksAppAsApi
- Login Via “App as API”
- Summary
-
The Case Study - Create Random Users Utility
@Test
-
A Utility
@Test
Case -
The Main Utility
@Test
Method -
Configuring the
@Test
User Creation Utility - Local Abstractions Overview
- Summary
-
A Utility
-
The Case Study - API Abstraction
- Overview of the API Abstractions
-
TracksApiEndPoints
Explained -
TracksApi
- Domain Objects
- Summary
-
The Case Study - Sending HTTP Calls using REST Assured
-
HttpMessageSender
- Summary
-
-
The Case Study - the
Test
Code Explored- What Makes It ‘test’?
-
TestEnvDefaults
- Synchronisation
-
Synchronisation with
Wait
-
TracksResponseProcessor
- Summary
-
The Case Study - the Authentication
@Test
Methods Explored- Evolving the Authentication Tests
-
AuthenticationTest
- Final Test
- Summary
-
The Case Study - the Project
@Test
Methods Explored- Create Project
- Amend
- Delete
- Summary
-
The Case Study - the Task
@Test
Methods Explored- Supporting Private Methods
- Create
- Delete
- Summary
-
REST Assured JSON and XML Processing
- Code Example Location
- What Is XML?
- What Is JSON?
- REST Assured JSON and XML Parsing
- XML Attributes with GPath
-
JsonPath
andXmlPath
- Parsing from File or String
- Parsing from URI
- Deserialization to Objects
- Deserialization in Practice
- Serialization in Practice
- More Information
- Summary
-
Summary of REST Assured
- Adding REST Assured with Maven
- Setting a Proxy for REST Assured
- Sending Message with REST Assured
-
given
,when
,then
-
Using
given
to Set the Message Details -
Using
when
to Make HTTP Requests -
Using
then
to Process Response - Basic Example
-
Assertions Using
body
inthen
- JsonPath and XmlPath
- Serialization and Deserialization
- Summary
-
Suggested Exercises
- Installation Exercises
- Coding Exercises
- Refactor and Expand
- Summary
-
Future Refactoring
-
Instead of Returning a
Response
Object - What Would You Do?
- Refactoring Resources
- Summary
-
Instead of Returning a
-
Conclusions and Summary
- Next Steps
- Reminder of the Non-Obvious
- App as API
- REST Assured Wrapped with Abstractions
- Test Data Creation Through Web Scraping
- Random Test Data Creation
- Extensive Abstraction Creation
- Summary
-
Appendix - Random Data Creation for v 2.3.0 Testing
- Symbol Replacement
-
Interface
TestDataRetriever
-
RandomFoodBackedDataRetriever
- Generating a Project Name or TODO
- Summary
-
Appendix - Other REST GUI Clients
- Chrome Applications
- Desktop Applications
- Firefox Plugin
- IDE and Editor Plugins
- Appendix - HTTP Debug Proxy and Proxy Support Tools
-
Appendix - Creating Random Data for Tracks v 2.2.0 Testing
- Approach
- Scraping Data Support Classes
- Scraping Data Code
-
Testing the Utility
@Test
Class -
Setup Data with the Utility
@Test
Class
-
Exploring Tracks API with Postman REST Client
- Using Postman Through a Proxy
- Shared Cookie Jar Gotcha
- About the Author
Authors have earned$9,883,643writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
OpenIntro Statistics
David Diez, Christopher Barr, Mine Cetinkaya-Rundel, and OpenIntroA complete foundation for Statistics, also serving as a foundation for Data Science.
Leanpub revenue supports OpenIntro (US-based nonprofit) so we can provide free desk copies to teachers interested in using OpenIntro Statistics in the classroom and expand the project to support free textbooks in other subjects.
More resources: openintro.org.
Functional Design and Architecture
Alexander GraninSoftware Design in Functional Programming, Design Patterns and Practices, Methodologies and Application Architectures. How to build real software in Haskell with less efforts and low risks. The first complete source of knowledge.
R Programming for Data Science
Roger D. PengThis book brings the fundamentals of R programming to you, using the same material developed as part of the industry-leading Johns Hopkins Data Science Specialization. The skills taught in this book will lay the foundation for you to begin your journey learning data science. Printed copies of this book are available through Lulu.
C++20
Rainer GrimmC++20 is the next big C++ standard after C++11. As C++11 did it, C++20 changes the way we program modern C++. This change is, in particular, due to the big four of C++20: ranges, coroutines, concepts, and modules.
I am a Software Engineer and I am in Charge
Alexis Monville and Michael DoyleI am a Software Engineer and I am in Charge is a real-world, practical book that helps you increase your impact and satisfaction at work no matter who you work with.
In the book, we will follow Sandrine, a fictional character who learns to think in a new way enabling her to take a different course of action.
Atomic Kotlin
Bruce Eckel and Svetlana IsakovaFor both beginning and experienced programmers! From the author of the multi-award-winning Thinking in C++ and Thinking in Java together with a member of the Kotlin language team comes a book that breaks the concepts into small, easy-to-digest "atoms," along with exercises supported by hints and solutions directly inside IntelliJ IDEA!
Invest In Digital Health - The Medical Futurist's Guide
Dr. Bertalan MeskoArtificial Intelligence and Digital Health are booming. In this book, we explain why now it's a good time to invest in Digital Health and give recommendations on where to invest by looking at the top 24 technological trends we find the most promising.
The Hundred-Page Machine Learning Book
Andriy BurkovEverything you really need to know in Machine Learning in a hundred pages.
Mastering STM32
Carmine NovielloWith more than 600 microcontrollers, STM32 is probably the most complete ARM Cortex-M platform on the market. This book aims to be the first guide around that introduces the reader to this exciting MCU portfolio from ST Microelectronics and its official CubeHAL.
Top Bundles
- #1
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #2
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #3
The Future of Digital Health
6 Books
We put together the most popular books from The Medical Futurist to provide a clear picture about the major trends shaping the future of medicine and healthcare. Digital health technologies, artificial intelligence, the future of 20 medical specialties, big pharma, data privacy and how technology giants such as Amazon or Google want to conquer... - #4
Cisco CCNA 200-301 Complet
4 Books
Ce lot comprend les quatre volumes du guide préparation à l'examen de certification Cisco CCNA 200-301. - #5
CCDE Practical Studies (All labs)
3 Books
CCDE lab - #6
"The C++ Standard Library" and "Concurrency with Modern C++"
2 Books
Get my books "The C++ Standard Library" and "Concurrency with Modern C++" in a bundle. The first book gives you the details you should know about the C++ standard library; the second one dives deeper into concurrency with modern C++. In sum, you get more than 600 pages full of modern C++ and about 250 source files presenting the standard library... - #7
Modern Management Made Easy
3 Books
Read all three Modern Management Made Easy books. Learn to manage yourself, lead and serve others, and lead the organization. - #8
Linux Administration Complet
4 Books
Ce lot comprend les quatre volumes du Guide Linux Administration :Linux Administration, Volume 1, Administration fondamentale : Guide pratique de préparation aux examens de certification LPIC 1, Linux Essentials, RHCSA et LFCS. Administration fondamentale. Introduction à Linux. Le Shell. Traitement du texte. Arborescence de fichiers. Sécurité... - #9
Programming with Ease
3 Books
Alle drei Bände der Serie Programming with Ease in einem Paket. Darin findest du alles, was ich dir zu den wichtigsten Phasen der Softwareentwicklung im Hinblick auf Clean Code Development für langfristig hohe Produktivität sagen kann.Im Band Slicing findest du die Anforderungsanalyse im Rahmen eines iterativ-inkrementellen Vorgehensmodells aus... - #10
Vagrant Ansible
2 Books
Unveil the power of Ansible and Vagrant with this bundle at a special price. You'll have everything you need to get started with Vagrant - learn the basics and how to create your virtual development environments, using Ansible as provisioner! About Vagrant Cookbook Vagrant Cookbook is a complete guide to get started with Vagrant and create your...