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.
About the Author
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
GETAPI 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
@TestCase -
The Main Utility
@TestMethod -
Configuring the
@TestUser Creation Utility - Local Abstractions Overview
- Summary
-
A Utility
-
The Case Study - API Abstraction
- Overview of the API Abstractions
-
TracksApiEndPointsExplained -
TracksApi - Domain Objects
- Summary
-
The Case Study - Sending HTTP Calls using REST Assured
-
HttpMessageSender - Summary
-
-
The Case Study - the
TestCode Explored- What Makes It ‘test’?
-
TestEnvDefaults - Synchronisation
-
Synchronisation with
Wait -
TracksResponseProcessor - Summary
-
The Case Study - the Authentication
@TestMethods Explored- Evolving the Authentication Tests
-
AuthenticationTest - Final Test
- Summary
-
The Case Study - the Project
@TestMethods Explored- Create Project
- Amend
- Delete
- Summary
-
The Case Study - the Task
@TestMethods 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
-
JsonPathandXmlPath - 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
givento Set the Message Details -
Using
whento Make HTTP Requests -
Using
thento Process Response - Basic Example
-
Assertions Using
bodyinthen - JsonPath and XmlPath
- Serialization and Deserialization
- Summary
-
Suggested Exercises
- Installation Exercises
- Coding Exercises
- Refactor and Expand
- Summary
-
Future Refactoring
-
Instead of Returning a
ResponseObject - 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
@TestClass -
Setup Data with the Utility
@TestClass
-
Exploring Tracks API with Postman REST Client
- Using Postman Through a Proxy
- Shared Cookie Jar Gotcha
- About the Author
The Leanpub 60-day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
80% Royalties. Earn $16 on a $20 book.
We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.
(Yes, some authors have already earned much more than that on Leanpub.)
In fact, authors have earned$12,307,240writing, publishing and selling on Leanpub.
Learn more about writing on Leanpub
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) and EPUB (for phones, tablets and 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
- #1
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.
- #2
Personal Finance
Jason AndersonThis textbook provides an in-depth analysis on personal finance that is both practical and straightforward in its approach. It has been written in such a way that the readers can gain knowledge without getting overwhelmed by the technical terms. Suitable for both beginners and advanced learners.
- #3
Getting to Know IntelliJ IDEA
Trisha Gee and Helen ScottIf we treat our IDE as a text editor, we are doing ourselves a disservice. Using a combination of tutorials and a questions-and-answers approach, Getting to Know IntelliJ IDEA will help you find ways to use IntelliJ IDEA that enable you to work comfortably and productively as a professional developer.
- #4
C++20 - The Complete Guide
Nicolai M. JosuttisAll new language and library features of C++20 (for those who know previous C++ versions).
The book presents all new language and library features of C++20. Learn how this impacts day-to-day programming, to benefit in practice, to combine new features, and to avoid all new traps.
Buy early, pay less, free updates.
Other books:
- #5
Mastering STM32 - Second Edition
Carmine NovielloWith more than 1200 microcontrollers, STM32 is probably the most complete ARM Cortex-M platform on the market. This book aims to be the most complete guide around introducing the reader to this exciting MCU portfolio from ST Microelectronics and its official CubeHAL and STM32CubeIDE development environment.
- #6
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.
- #7
Machine Learning Q and AI
Sebastian Raschka, PhDHave you recently completed a machine learning or deep learning course and wondered what to learn next? With 30 questions and answers on key concepts in machine learning and AI, this book provides bite-sized bits of knowledge for your journey to becoming a machine learning expert.
- #8
Stats One
William Foote - #9
The Rails 7 Way
Obie Fernandez, Lucas Dohmen, and Tom Henrik AadlandThe Rails™ 7 Way is the comprehensive, authoritative reference guide for professionals delivering production-quality code using modern Ruby on Rails. It illuminates the entire Rails 7 API, its most powerful idioms, design approaches, and libraries. Building on the previous editions, this edition has been heavily refactored and updated.
- #10
Gradual Modularization for Ruby and Rails
Stephan HagemannGet yourself a new tool to manage your Rails application and your growing engineering organization! Prevent the ball-of-mud (and fix it!). Go for microservices or SOA if it makes sense not just because you don't have any other tool. Do all this through a low-overhead tool: packages. Enable better conversations to make practical changes today.
Top Bundles
- #1
Software Architecture
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
1500 QUIZ COMMENTATI (3 libri)
3 Books
Tre libri dei QUIZ MMG Commentati al prezzo di DUE! I QUIZ dei concorsi ufficiali di Medicina Generale relativi agli anni: 2000-2001-2003-2012-2013-2014-2015-2016-2017-2018-2019-2020-2021 +100 inediti Raccolti in unico bundle per aiutarvi nello studio e nella preparazione al concorso. All'interno di ogni libro i quiz sono stati suddivisi per... - #4
Pattern-Oriented Memory Forensics and Malware Detection
2 Books
This training bundle for security engineers and researchers, malware and memory forensics analysts includes two accelerated training courses for Windows memory dump analysis using WinDbg. It is also useful for technical support and escalation engineers who analyze memory dumps from complex software environments and need to check for possible... - #5
Practical FP in Scala + Functional event-driven architecture
2 Books
Practical FP in Scala (A hands-on approach) & Functional event-driven architecture, aka FEDA, (Powered by Scala 3), together as a bundle! The content of PFP in Scala is a requirement to understand FEDA so why not take advantage of this bundle!? - #6
Modern C++ Collection
3 Books
Get All about Modern C++C++ Standard Library, including C++20Concurrency with Modern C++, including C++20C++20Each book has about 200 complete code examples. Updates are included. When I update one of the books, you immediately get the updated bundle. You can expect significant updates to each new C++ standard (C++23, C++26, .. ) and also... - #7
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
Development and Deployment of Multiplayer Online Games, Part ARCH. Architecture (Vol. I-III)
3 Books
What's the Big Idea? The idea behind this book is to summarize the body of knowledge that already exists on multiplayer games but is not available in one single place.And quite a fewof the issues discussed within this series (planned as three nine volumes ~300 pages each), while known in the industry, have not been published at all (except for... - #10
Growing Agile: The Complete Coach's Guide
7 Books
Growing Agile: Coach's Guide Series This bundle provides a collection of training and workshop plans for a variety of agile topics. The series is aimed at agile coaches, trainers and ScrumMasters who often find themselves needing to help teams understand agile concepts. Each book in the series provides the plans, slides, handouts and activity...
