Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.2 KB

API_STRESS_TESTING_WITH_JMETER.md

File metadata and controls

47 lines (30 loc) · 2.2 KB
Raw

API Stress-Testing with JMeter

Introduction

This article describes several keypoint elements to test your RESTful APIs. To begin with, you should make sure you have installed the following softwares or SDK:

Author: @LucasXU

Basic Usage

  1. Enter bin directory and run jmeter.bat (on Windows) or jmeter.sh (on Linux), you will see GUI of JMeter as follows:

GUI

  1. Right-click testplan, choose Add-Threads(Users)-Thread Group

Thread-group

  1. Modify the default settings:
    There are mainly 3 key params:
  • Number of Threads (users) means how many QPS you will create to hit your API, since JMeter utilize Thread to mock user visit
  • Ramp-Up Period (in seconds) means how long your threads will be executed done. Take the following image setting as an example, it denotes that 800 threads will be executed done within 10 seconds. Namely, the average QPS is about 80/s.
  • Loop Count means the loop times will the thread group will be executed

Thread Group Setting

  1. Right-click Thread Group, choose Add-Sampler-HTTP Request

Add HTTP Thread

  1. Modify the default settings, such as protocol, server/IP, port number, send params, and etc.

HTTP Request Setting

  1. Click Start button, it will start sending HTTP requests to your API

  2. Right-click Add-Listener-Summary Report/View Results Tree to view execution details

View

  1. As mentioned by JMeter terminal--Don't use GUI mode for load testing !, only for Test creation and Test debugging. You should save your TestPlan.jmx file, and execute test plan with command line:
./jmeter.sh -n -t ./testplan/YOUR_TEST_PLAN.jmx -l testplan/result/result.txt -e -o testplan/webreport

It will generate results file and web report, just open the index.html with your browser, you will see:

Web Report