Soap - A Laravel SOAP client that provides a clean interface for handling requests and responses

Published on by

Soap - A Laravel SOAP client that provides a clean interface for handling requests and responses image

Nobody likes having to work with SOAP APIs, but we don't always get a choice. So why hasn't anybody done anything about it yet? Soap is a plug-and-play package for Laravel that makes SOAP (dare I say) enjoyable to work with in your applications. If you've worked with the Http client introduced in Laravel 7, you'll feel right at home.

Making your first Soap request is simple using the provided Soap facade:

$customers = Soap::to('https://api.example.com')
->withBasicAuth('username', 'password')
->Customers(['SortBy' => 'name']);

Faking Requests

One of the biggest challenges developers face when working with SOAP APIs is mocking requests and responses for unit tests or local development. With the Soap package, all of those challenges disappear:

Soap::fake(
'http://api.example.com:Customers' => Response::new([['name' => 'Garry'], ['name' => 'Bob']])
);
 
// This request will now return our requested response
$customers = Soap::to('https://api.example.com')->Customers(['SortBy' => 'name']);
 
// When faking, you can perform inspections on requests too!
Soap::assertSent(function($request, $response) {
return in_array('Garry', $response->response);
});
 
Soap::assertSentCount(1);

Using Hooks

Almost every SOAP API has some strange quirk that you need to factor in. It can be frustrating to require messy conditional logic to normalize the data in your code. With the Soap package, you can move all of that logic out of the way using hooks.

For example, imagine that the SOAP API you're using requires a Version parameter with each request. You don't want to include that manually in each location you call the API. Instead, you can place a global hook that will fire before each request to include the Version parameter automatically.

// AppServiceProvider
 
public function boot() {
Soap::beforeRequesting(function($request) {
$request->set('Version', config('example-soap-api.version'));
});
}

Debugging with Ray

Want to debug a SOAP request in your application. The Soap package ships with support for Spatie's Ray debugging app. Just call ray()->showSoapRequests(), and you'll get a nicely formatted table with the endpoint, method, request, and response body in the Ray app every time a new SOAP request gets made.

Learn More

Soap is open source under the MIT license, and it's already used in multiple production applications. If you're fed up of wrangling with SOAP requests, check out the source code and in-depth documentation on GitHub.

Luke Downing photo

Full stack developer at Worksome. CEO of Downing Tech. Big fan of TDD, and maintainer of the Pest PHP testing framework.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Tinkerwell

Version 4 of Tinkerwell is available now. Get the most popular PHP scratchpad with all its new features and simplify your development workflow today.

Visit Tinkerwell

The latest

View all →
Use Ollama LLM Models Locally with Laravel image

Use Ollama LLM Models Locally with Laravel

Read article
TallStackUI - a new component library for TALL Stack apps image

TallStackUI - a new component library for TALL Stack apps

Read article
Laravel 10.34 Released image

Laravel 10.34 Released

Read article
Laravel Tailwind Merge image

Laravel Tailwind Merge

Read article
Generate Validation Rules from a Database Schema in Laravel image

Generate Validation Rules from a Database Schema in Laravel

Read article
A Feature Flags Implementation for Filament image

A Feature Flags Implementation for Filament

Read article
Honeybadger logo

Honeybadger

Zero-instrumentation, 360 degree coverage of errors, outages and service degradation.

Honeybadger
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Oh Dear logo

Oh Dear

Oh Dear is the best all-in-one monitoring tool for all your Laravel apps.

Oh Dear
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
LoadForge logo

LoadForge

Easy, affordable load testing and stress tests for websites, APIs and databases.

LoadForge
Paragraph logo

Paragraph

Manage your Laravel app as if it was a CMS – edit any text on any page or in any email without touching Blade or language files.

Paragraph
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. Partner with Lucky Media, your favorite Laravel Development Agency!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce