ServiceNow REST API Tester

A PyQt6-based graphical user interface for testing REST API endpoints, with a focus on ServiceNow APIs. This tool simplifies the process of building requests (including headers, payload, and authentication), sending requests, viewing responses in both raw and structured tree formats, and visualizing numeric response data.

Features

• GUI-based: No need to manage cURL commands or raw JSON files—interact through a clean PyQt6 interface.
• Multiple HTTP Methods: Support for GET, POST, PUT, DELETE, PATCH, OPTIONS, and HEAD.
• Authentication Options: Supports Basic and Bearer Token authentication.
• JSON Editors: Built-in ACE editor for headers and payload, with formatting and template insertion.
• Tree View: Visualize response payload structures in a hierarchical tree.
• Visualization: Basic bar chart generation from numeric JSON responses using matplotlib.

Screenshot

Installation

1. Clone the repository:

   git clone https://github.com/D-Ogi/servicenow-rest-api-tester.git

2. Install Python dependencies:

   cd servicenow-rest-api-tester
   pip install matplotlib requests PyQt6 PyQt6-WebEngine Pillow

3. Run the Application:

   python api.py

Configuration

• config.json:
  The application loads and saves configuration details here.
  • url: Default API endpoint URL.
  • method: Default HTTP method.
  • auth_type: Default authentication type.
  • username, password: For Basic Auth.
  • token: For Bearer Token Auth.
  • headers: Default headers as JSON.
  • payload: Default request payload as JSON.
  • templates: JSON templates for payload insertion.

Usage

1. Launch the application.
2. Enter the endpoint URL and select the HTTP method.
3. Choose authentication type and provide credentials if necessary.
4. Edit headers and payload in the ACE editor.
5. Click "Send Request" to execute the request.
6. View raw response or navigate through the JSON structure in the tree view.
7. If applicable, visualize numeric data by switching to the "Visualization" tab.

UI Buttons overview

The application provides several key buttons to streamline your workflow when interacting with REST APIs:

1. Format JSON Payload
   Purpose: Automatically formats and re-indents the JSON payload you’ve entered into the payload editor.
   When to Use: If you have pasted raw, unformatted JSON or made manual edits, click this button to ensure the payload is consistently and neatly formatted, making it easier to read and debug.

2. Insert Template
   Purpose: Quickly insert predefined JSON templates into the payload editor.
   When to Use: If you frequently send similar types of requests (e.g., creating incidents or updating change requests in ServiceNow), this button saves time by letting you choose from predefined templates instead of manually typing or pasting the JSON each time.

3. Send Request
   Purpose: Execute the API request using the currently defined URL, HTTP method, headers, payload, and authentication settings.
   When to Use: Once you have finalized your request details—auth credentials, payload, headers—click this button to send the request and populate the "Raw Response," "Tree View," and optional visualization tabs with the resulting data.

Templates

Load predefined templates for common API payloads (e.g., for creating incidents or updating change requests in ServiceNow). This feature can speed up testing by inserting ready-to-use JSON structures.

Changelog

All notable changes to this project will be documented in this file.

2024-12-19

• Initial setup of repository