Adam Tuttle

Taffy 3.3 release: What's inside?

Taffy 3.2.0 was an extremely stable release, as evidenced by the fact that it was published on November 10th 2017 (nearly 4 years ago!) and that was the last release until today.

Taffy 3.3.0 is out now! Download it here!

Screen shot of Taffy 3.3.0 improvements to the inline documentation in the dashboard

To be fair, much of what's new in Taffy 3.3.0 has been there for a while. I was mostly just too busy or too lazy to create an official release for it. But some new features that I've added in recent weeks definitely deserve some attention and a new version number. As (almost) always, you can check the release notes for all details of what's new in Taffy 3.3.0, but here are some highlights:

Sample responses, you say? #

Yup! Have you ever tried to onboard a new API consumer and wanted to give them a way to interact with the API to verify they're calling it correctly, but either don't have real data for them yet or don't want them testing against it? Enter sample responses and simulated requests.

You specify the sample response for your GET method by adding a sampleGetResponse method that returns the raw data of your sample response. It doesn't receive any input arguments.

function sampleGetResponse() {
return [
{
indentationMethod: "tabs",
rating: "superior",
},
{
indentationMethod: "spaces",
rating: "inferior",
},
];
}

Your sample responses will automatically be displayed in a nice little collapsable drawer in the dashboard and docs pages.

If a simulated request is made, the sample response data is returned rather than running the request normally. If there is no applicable sample response method, the simulated request returns status 400.

By default simulated requests are made by adding ?sampleResponse=true to your request (or e.g. {"sampleResponse":true} in a POST body...). You can override both the key and the password using the new simulateKey and simulatePassword configuration attributes.

Of course there's much more that's new and improved, but those are the highlights. Enjoy!