Skip to content

SeUniVr/RestLeague

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

8 Commits
Β 
Β 
Β 
Β 

Repository files navigation

REST League

πŸ† REST API Black-Box Testing Tool Competition

Welcome to REST League, the ultimate competition for automated black-box testing tools designed for RESTful APIs.

The goal of REST League is to evaluate the performance of open-source and proprietary tools in finding bugs, security vulnerabilities, and logic flaws in real-world REST APIs without access to their source code.

🎯 The Challenge

Participants submit their automated black-box testing tools to compete against a benchmark set of REST APIs. These APIs contain a variety of intentionally injected issues, ranging from functional defects to common security flaws.

What is black-box testing?

In this context, black-box testing means the tools interact with an API solely via its public endpoints, documented by an OpenAPI specification. Tools generate test cases by leveraging the specification and the feedback from the API, without looking at the API's internal implementation.

πŸ› οΈ Tool Requirements

Tools must meet the following general requirements to participate

  • Automation: The core testing process must be fully automated and reproducible
  • Black-box: Must operate strictly without access to the API's source code
  • Target: Must be explicitly designed to test REST APIs
  • Containerized: Submissions must be easily deployable, via a Docker image

In particular, the tools must be compatible with RESTgym, a benchmarking infrastructure specifically designed for REST API testing tools. Check here the details of our experimental setting.

πŸ“Š Evaluation Criteria

Tools will be scored based on a comprehensive set of criteria, focusing on both quality of testing and resource efficiency

  1. Fault Detection: The total number of unique 5XX responses obtained by the tool
  2. Operation Coverage: The extent of API endpoints successfully tested (obtaining a 2XX response)
  3. Code Coverage: The extent of API code effectively explored during testing (measured in terms of methods, statements, and branches covered)
  4. Testing Efficiency: The time taken and the number of requests needed to achieve the fault and coverage results

The final score will be a weighted aggregate of these metrics. Testing metrics will be collected by using the Restats tool.

πŸ’‘ How to Participate

  1. Register: Fill out the Registration Form to officially enter your tool
  2. Prepare: Ensure your tool meets all requirements and is ready for deployment
  3. Submit: Provide access to your tool, along with detailed setup and execution instructions
  4. Document: Submit a short report (max 2 pages) documenting how the tool works

Sandboxed Execution: All submitted tools will be run in a secure, isolated, and controlled environment by REST League organizers. Details of the machine used to run the experiments will be provided after registration.

πŸ—“οΈ Competition Timeline

REST League will be hosted by SBFT@ICSE2026 in Rio de Janeiro, Brazil, with the following schedule.

Date (AoE) Event
[17/10/2025] Call for Participation Opens (Tool Registration)
[05/12/2025] Final Deadline for Tool Submission
[01/01/2026] Notification of results
[26/01/2026] Tool report camera ready deadline
TBA REST League Awards Ceremony

πŸ† Awards & Recognition

  • πŸ₯‡ Gold API Tester: Tool with the highest overall score (ultimate champion)
  • πŸ₯ˆ Silver API Tester: Tool with the second-highest overall score
  • 🐞 Bug Hunter: Tool with the highest number of unique 5XX found
  • ⚑ Roadrunner: Tool that achieves the highest coverage with the lowest resource consumption footprint

Winning tools and their authors will be prominently featured on this GitHub page, recognized at the Awards Ceremony, and invited to present their tool during SBFT@ICSE2026 in Rio.

ACM Publication: The tool report for all participants will be included in the SBFT@ICSE2026 proceedings and published by ACM.

πŸš€ Boostrapping

To quickly develop your REST API testing tool, you can consider using the RestTestGen Framework. The framework provides many ready-to-use components to:

  • parse OpenAPI specifications
  • handle HTTP interactions
  • model test cases
  • generate operation parameter values
  • check testing oracles
  • mutate HTTP requests
  • ... and more

All components and the testing engine are easily customizable, to develop brand new testing tools in minutes. For more details, see the RestTestGen Framework Wiki.

πŸ” Testing the Testing Tool

Before submitting your tool to REST League, please check its compliance with RESTgym for easy deployment and running on our platform.

All tools will be run with a time budget of one hour for each API; experiments will be repeated ten times, averaging the results.

You can test your tool on the REST APIs provided in the apis directory of this repository (see the specific apis/README for details) and on the APIs available in RESTgym.

🀝 Organizers & Contact

REST League is organized by

If you have questions, feel free to reach out to us!

About

REST League

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published