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
Authors have earned$9,542,965writing, 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
- #1
Algebra-Driven Design
Sandy MaguireA how-to field guide on building leak-free abstractions and algebraically designing real-world applications.
- #2
Production Haskell
Matt ParsonsAre you excited about Haskell, but don't know where to begin? Are you thrilled by the technical advantages, but worried about the unknown pitfalls? This book has you covered.
- #3
The Hundred-Page Machine Learning Book
Andriy BurkovEverything you really need to know in Machine Learning in a hundred pages.
- #4
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #5
Machine Learning Engineering
Andriy Burkov"If you intend to use machine learning to solve business problems at scale, I'm delighted you got your hands on this book."
—Cassie Kozyrkov, Chief Decision Scientist at Google
"Foundational work about the reality of building machine learning models in production."
—Karolis Urbonas, Head of Machine Learning and Science at Amazon
- #6
Cloud Strategy
Gregor Hohpe“Strategy is the difference between making a wish and making it come true.” A successful migration to the cloud shouldn’t be driven by wishes, but guided by a sound strategy, frameworks, and decision models. This book tells you how—without becoming superficial nor getting lost in technology and product details.
- #7
CCIE Service Provider Version 4 Written and Lab Exam Comprehensive Guide
Nicholas RussoThe service provider landscape has changed rapidly over the past several years. Networking vendors are continuing to propose new standards, techniques, and procedures for overcoming new challenges while concurrently reducing costs and delivering new services. Cisco has recently updated the CCIE Service Provider track to reflect these changes; this book represents the author's personal journey in achieving that certification.
- #8
CCIE SP v4.1 - Workbook
Łukasz Bromirski, Piotr Jablonski, and Nicholas RussoAre you striving to prepare to and pass CCIE SP lab exam? Take the opportunity and get this workbook! With the attached initial cfg files you will prepare yourself for the CCIE SP exam as well as learn SP technologies applicable to all kinds of today modern networks! This workbook covers blueprint topics and provides challenging examples.
- #9
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
- #10
Introducing EventStorming
Alberto BrandoliniThe deepest tutorial and explanation about EventStorming, straight from the inventor.
Top Bundles
- #1
The Node.js Bundle
3 Books
This bundle combines three bestselling Leanpub Node.js books into a package that gives you everything you need to get started with developing Node.js applications at an unbeatable price. - #2
The Tester's Library
8 Books
The Tester's Library consists of eight five-star books that every software tester should read and re-read. As bound books, this collection would cost over $200. Even as e-books, their price would exceed $80, but in this bundle, their cost is only $49.99. Here are the books, and why they should be in your library: Perfect Software and Other... - #3
agile
11 Books
In this bundle, you will find 10 different agile books. They are about different aspects of being agile. - finding a job - doing coding dojo's - Retrospectives - Personal kanban - a non-typical coaching book and even a book that gives you an insight in the lives of some agile people. - #4
WTFlop 6M + HU - Beta Bundle
6 Books
- #5
Node Patterns
6 Books
- #6
Fifty Quick Ideas
3 Books
Get all three books for the price of two! Fifty Quick Ideas books are full of practical, real-world techniques that you can use to improve teamwork, build better products and build them in a better way. - #7
Growing Agile: Coach's Guide Series
4 Books
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 instructions to run a number of... - #8
Marionette.js A to Z
3 Books
Marionette.js has become a popular Backbone-based javascript library, because it helps you avoid boiler-plate code and focus on what makes your app special. But how do you get started?Whether you want to finally get started with dynamic client-side programming (like one reader did), or are an experienced front-end dev who has inherited a... - #9
Complete Scala Bundle
3 Books
Scala is a general-purpose programming language and it's getting extremely popular these days. Some say that learning Scala could be a challenging task. My experience, however, suggests that this is actually a myth that has very little to do with reality. With the right approach, learning Scala can be easy, fun and rewarding.The first book from... - #10
Build A Better Backbone App
3 Books
The best way to learn new development skills is through experience, but that takes time you don't have.Get the best of both worlds with this bundle: you'll learn how to produce modern web applications by learning from experienced developers like Derick Bailey and David Sulc. BackboneJS is one of the favorite tools on the web today, but it...
