Learn API Testing

Explore software web application architecture, API testing, coding practices, and the standards for better API test automation development and management. This book focuses on aspiring software testing engineers currently working in API testing, and those starting their journey in the field of software testing.

You’ll begin with an introduction to API testing and software web applications involving APIs. The book then moves on to the authentication standards used in the software industry, and the tools, the frameworks, and the libraries used in API testing. As the book progresses, you’ll learn about the test pyramid, how to test an API, what makes a good test script, and various coding guidelines. Finally, you get to write your own API test script.

Learn API Testing is your pathway to understanding a typical software web application, its requests and responses, and the properties of a good test script.

WHAT YOU’LL LEARN

* Examine practices, standards, and guidelines for effective test automation


* Work with different tools like RestAssured, Curl, and Postman
* Understand API testing paradigm (internal/external APIs, CDCT)
* Review a case study on the industrial software API testing process
* Organize a test framework

WHO THIS BOOK IS FOR

API testing aspirants, developers/architects, project managers, and non-technical team members who may want to understand how APIs are being tested.

Jagdeep Jain has more than 15 years of experience in Software Quality Assurance and Testing working in various product development software companies. He holds a degree in Computer Science & Engineering. He is a firm believer and advocate of test automation. He has Co-Authored Pro Apache JMeter with Sai Matam.

Chapter 1: Introduction to API Testing

CHAPTER GOAL: HELP THE READER IDENTIFY THE PURPOSE OF THE BOOK, TARGET AUDIENCE AND SKILLS SET REQUIRED TO PERFORM API TESTING

NO OF PAGES -

SUB -TOPICS

1. What is API Testing

2. Why We Need API Testing

3. Types of API Testing

4. Advantages

Chapter 2: Software Application

CHAPTER GOAL: GAIN KNOWLEDGE ABOUT SOFTWARE WEB APPLICATION STANDARDS WHICH INVOLVES APIS

No of pages: -

SUB - TOPICS

1. REST Client/Server Architecture

2. Monolithic Vs. Microservices based web application

3. HTTP(s)

4. Header(s)

5. Request / Response

6. Response Codes

Chapter 3: Authentication

CHAPTER GOAL: STANDARD AUTHENTICATION USED IN INDUSTRY

No of pages : -

SUB - TOPICS:

1. Basic Authentication

2. Session Based Authentication

3. Token / JWT Based Authentication

4. OAuth2 Based Authentication

Chapter 4: Tools

CHAPTER GOAL: UNDERSTANDING OF TOOLS USED FOR DOING API TESTING

NO OF PAGES: -

SUB - TOPICS:

1. Postman

2. CURL

3. RestAssured

4. TestNG

5. Log4j

6. Java - Spring Boot

Chapter 5: Test Pyramid

CHAPTER GOAL: TESTING TYPES AND HIERARCHY OF EACH TYPE

NO OF PAGES: -

SUB - TOPICS:

1. Black Box Testing

2. Grey Box Testing

3. Unit Testing

4. Components of Test Pyramid

Chapter 6: Testing The API

· CHAPTER GOAL: API TESTING PARADIGM (INTERNAL/EXTERNAL APIS., CDCT)

NO OF PAGES: -

SUB - TOPICS:

1. Manual Test Script/ Workflows/ Use Cases

2. What to Test

a. Schema

b. Data

c. Data Type

3. Coverage Good / Bad

4. Headers Testing

a. Request Header

i. Correct Header

ii. Missing Header

iii. Incorrect Header

iv. Unsupported Type

b. Response Header

i. Supported Type

ii. Header Response

iii. Response Codes

5. Request Body

a. Format Unsupported

b. Special Characters

c. Too long String

d. Invalid value

e. Wrong data type

f. Empty data/object

g. Required fields

h. Null

i. Redundant fields

j. DELETE already deleted entity

k. Use PUT in place of POST etc.

6. Response Body

a. Actual Data vs. Expected Data

b. Limit

7. Internal vs. External APIs

8. CDCT – Consumer Driver Contract Testing

9. Risk

a. Importance of Negative Testing

Chapter 7: A Good Test Script

CHAPTER GOAL: PROPERTIES OF A GOOD TEST SCRIPT

NO OF PAGES: -

SUB - TOPICS:

1. Components of a Good Test Script

2. Example

Chapter 8: Coding Guidelines

Chapter Goal: Using standard coding guidelines for better test management and review.

NO OF PAGES: -

SUB - TOPICS:

1. Google Best Practices

2. Test Naming Conventions

3. Method Naming Convention

4. Others

Chapter 9: Organize Test Framework

CHAPTER GOAL: ORGANIZE A TEST FRAMEWORK IN A WAY THAT IS USABLE ACROSS ANY TEAM / PROJECT

NO OF PAGES: -

SUB - TOPICS:

1. Maven Project

2. Dependencies

3. Spring Boot

4. Properties File/Environment Based

5. End Points

6. Authentication

7. Request

8. Response

9. Test Data

a. JSON

b. File

c. HashMap

d. TestNG data provider

10. Logging

Chapter 10: First Test

CHAPTER GOAL: WRITE FIRST TEST TO GET A FEEL OF API TESTING

No of pages: -

SUB - TOPICS:

1. Developing First Test

2. Executing First Test

3. Check Results

4. Check Logging

Chapter 11: API Documentation

CHAPTER GOAL: API DOCUMENTATION IS A MANDATORY REQUIREMENT FOR WRITING API TESTS, SWAGGER IS THE TOOL THAT IS BEING USED, WE WILL SEE HOW TO READ THE SWAGGER API DOCUMENTATION FOR BETTER UNDERSTANDING ON THE END POINTS.

NO OF PAGES: -

SUB - TOPICS:

1. Swagger

2. Why We Need API Documentation

3. Understanding the API Documentation

Chapter 12: Case Study – Shopping Cart APIs

CHAPTER GOAL: A SAMPLE APPLICATION IS USED TO DEMONSTRATE THE INDUSTRIAL WAY OF DOING API TESTING, THIS IS AN EQUIVALENT TO A WORKSHOP ON DOING API TESTING.

NO OF PAGES: -

SUB - TOPICS:

1. Setting Up Application

2. Goal Setting

3. Test Environment (Docker Container)

4. Test Data Preparation

5. Agile Testing

6. Shopping Cart API End Points

7. Understanding Business Requirements

8. Manual Tests Scripts

9. Implementing Test Framework

10. Writing Test

11. Test Suite

12. Execution

13. Results

14. Utilities