Skip to content

Add Python API Response Comparator Script #580

Description

@asxxb

Is your feature request related to a problem? Please describe.

When developing and testing APIs, comparing JSON responses manually can be time-consuming, especially when responses contain nested objects and arrays. It can be difficult to identify which fields were added, removed, or modified between two API responses.

Describe the solution you'd like

I would like to contribute a Python script that compares two JSON files and displays their differences in a readable format.

The script should:

Identify added, removed, and modified keys.

Support nested JSON objects and arrays.

Display the differences clearly in the terminal.

Accept two JSON file paths through command-line arguments.

Include example usage and unit tests.

Describe alternatives you've considered

Manually comparing JSON files or using online JSON comparison tools. A lightweight Python command-line utility would provide an offline alternative without requiring external services.

Additional context

The implementation would use Python's built-in json and argparse modules wherever possible to avoid unnecessary dependencies.

I plan to add the script in a dedicated folder with its own README.md and update the main repository README.md under the List of Scripts section, following the contribution guidelines.

I welcome feedback and suggestions from the maintainers before beginning implementation.

Activity

  1. github-actions commented on Oct 10, 2026

    @github-actions

    Thank you for raising this issue! Our team will review it soon.

    For more queries or discussions or approval of requests, please join the Discord server for further discussion: Discord Link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions