Simplify API Parameter Formatting with a Python @serialize_params Decorator

Many APIs require different payload formats (JSON, form‑data, XML, etc.), and manually switching between json= and data= in test scripts often leads to errors.

Effect of the @serialize_params decorator

Applying the decorator lets you always call the test function with data={...}; the decorator automatically converts the payload to the required format based on the content_type argument.

Step‑by‑step implementation

1. Understand Requests parameters

json=xxx

sends Content‑Type: application/json and serialises the object to JSON; data=xxx sends application/x‑www‑form‑urlencoded.

2. Write the decorator

from functools import wraps

def serialize_params(content_type='json'):
    """Convert a data dict to the specified request format."""
    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            data = kwargs.get('data', {})
            if content_type == 'json':
                kwargs['json'] = data
                kwargs.pop('data', None)
            elif content_type == 'form':
                pass  # keep data as‑is
            print(f"📤 Sending {content_type.upper()} data: {data}")
            return func(*args, **kwargs)
        return wrapper
    return decorator

3. Full runnable example

# Define decorator (as above)

@serialize_params(content_type='json')
def send_json_data():
    """Send JSON payload"""
    return requests.post('https://httpbin.org/post', data={'message': 'Hello JSON!'})

@serialize_params(content_type='form')
def send_form_data():
    """Send form‑encoded payload"""
    return requests.post('https://httpbin.org/post', data={'message': 'Hello Form!'})

if __name__ == '__main__':
    print("🚀 Testing parameter serialization...")
    resp1 = send_json_data()
    print("✅ JSON Content‑Type:", resp1.json()['headers'].get('Content-Type'))
    resp2 = send_form_data()
    print("✅ Form Content‑Type:", resp2.json()['headers'].get('Content-Type'))
    print("🎉 Done")

Advanced tips & common questions

Support for XML or file upload can be added by extending the content_type branch.

For mixed JSON‑and‑file requests, a dedicated helper is recommended instead of the generic decorator.

The decorator is useful in large test suites where dozens of endpoints use different formats, providing a uniform data= call style.

Key takeaways

The @serialize_params decorator abstracts the “how to send” logic, letting test writers focus on the data itself, reducing format‑related bugs and keeping test code consistent.