How to debug RESTful services? [closed]
Asked Answered
L

17

60

I'm looking for an easy way to debug RESTful services. For example, most webapps can be debugged using your average web browser. Unfortunately that same browser won't allow me to test HTTP PUT, DELETE, and to a certain degree even HTTP POST.

I am not looking to automate tests. I'd like to run new services through a quick sanity check, ideally without having to writing my own client.

Larine answered 3/10, 2008 at 4:48 Comment(0)
S
35

Use an existing 'REST client' tool that makes it easy to inspect the requests and responses, like RESTClient.

Sizzler answered 3/10, 2008 at 6:29 Comment(3)
Both of these look like extremely interesting tools, thanks for the pointers!Dirac
i am using first one , works simply nice for me.Bryonbryony
I wrote a REST client plugin called Requester for Sublime Text, github.com/kylebebak/Requester. It's inspired by HTTPie and Postman. It's very powerful and easy to use, and it's cross-platform. If you're not in love with your HTTP client it's definitely worth a try.Baeza
C
15

At my firm we use a variety of different tools and approaches to testing RESTful services:

  • We write cURL scripts - essentially a single command saved in a file. One file per resource per method. For PUT and POST, we'll usually have files containing the representations to send alongside the cURL script. For example, for a mailbox resource, we might have a file named mailbox_post.cmd, which might contain the line curl -v -X POST -u username -H 'Content-Type:application/xml' -d @mailbox_post.xml http://service/mailbox. We like this approach because we end up building a collection of tests which can be run in a batch, or at least passed around between testers, and used for regression testing.

  • We use cURL and RESTClient for ad-hoc tests

  • We have the service serve XHTML by default, so it's browsable, and add forms resources, so the service is actually partially or fully testable using a browser. This was partly inspired by some parts of RESTful Web Services, wherein the authors show that the line between web services and web applications may not need to be as solid and strict as is usually assumed.

  • We write functional tests as Groovy closures, using the Restlet framework, and run the tests with a test runner Groovy script. This is useful because the tests can be stateful, build on each other, and share variables, when appropriate. We find Restlet's API to be simple and intuitive, and so easy to write quick HTTP requests and test the responses, and it's even easier when used in Groovy. (I hope to share this technique, including the test runner script, on our blog soon.)

Cladoceran answered 3/10, 2008 at 13:28 Comment(0)
E
13

Postman, a Google Chrome extension, may be helpful.

Edit years later: Also the website of the url in case Chrome extension link gets changed: www.postman.com

Enenstein answered 3/10, 2008 at 4:48 Comment(4)
This is a relatively new extension, but simply for the ability to save sets of requests, and manage / share them + a nice interface, I'd recommend it very highly.Eliaeliades
Postman we can upload file requests too as multipart dataPsychosis
Dead link. I guess this app is it? I’m not sure.Speculum
@Speculum yes, that's it. I believe it is no more "only a chrome extension", now also a standalone app. You may also use Firecamp, Postwoman, Insomnia etc.Candleberry
C
8

I've found RequestBin useful for debugging REST requests. Post to a unique URL and request data are updated/displayed. Can help in a pinch when other tools are not available.

https://requestbin.com/

Cordeelia answered 3/10, 2008 at 4:48 Comment(0)
B
5

A tool I've found useful if you're running OS X Leopard:

HTTP Client

It's a very simple GUI program that allows you to craft http requests to a resource and view the response.

Beaufort answered 3/10, 2008 at 4:48 Comment(0)
W
4

You can use fiddler's Composer to debug restful services..

Updated JD 12 sep 2013: Rest Builder is now called Composer.

Wellappointed answered 3/10, 2008 at 4:50 Comment(1)
The link to Request Builder above is broken.Staff
S
4

cURL works just fine.

Sibilant answered 3/10, 2008 at 9:47 Comment(0)
L
3

I ended up settling on POSTMAN

It supports all REST features I could think of, and the UI is absolutely excellent. The only downside is that it requires Chrome.

Larine answered 3/10, 2008 at 4:48 Comment(1)
Now it is independent from chrome, U can use it without chrome, means direct installation,Atrocity
J
2

I'm using Soap UI to test my REST API.

It is more complete than any other tools:

  • fine debug requests and responses
  • automated testing
  • all GUI based
  • properties and properties transfer to parameterize your tests
  • conditional testing
  • performance testing

I'm not working for SmartBear. I was already a big fan of SoapUI while using it for SOAP WebServices.

My SoapUI REST Project

Janssen answered 3/10, 2008 at 4:48 Comment(0)
S
2

RESTTest for Firefox (an add-on). Fiddler for IE.

Shantelleshantha answered 3/10, 2008 at 4:48 Comment(1)
RestTest has been disabled (12 sep 2013)Ramey
W
0

because its totally missing here: https://luckymarmot.com/paw

Is worth ever penny...

Wegner answered 3/10, 2008 at 4:48 Comment(0)
F
0

You guys should check poster extension for firefox, it's simple and useful enough to use :)

Foxed answered 3/10, 2008 at 4:48 Comment(0)
P
0

Firefox's has RESTClient plug-in to send different request with methods, parameters, headers etc.

Prentice answered 3/10, 2008 at 4:48 Comment(0)
S
0

If you want free tool for the same purpose with additional feature of multipart form data submission it is here http://code.google.com/a/eclipselabs.org/p/restclient-tool/

Sinnard answered 3/10, 2008 at 4:48 Comment(0)
D
0

Aside from using one of the tools in Peter Hilton's response, I would have to say that scripting the tests with LWP or some similar tool may be your only option. You could bypass the use of LWP by just opening a socket, sending a raw HTTP request in and examining what you get in return. But as far as I know, there are a dearth of testing tools for this sort of domain-- most look at this problem-space primarily from the lens of a web-site developer, and for them the browser is enough of a testing platform.

Dirac answered 3/10, 2008 at 9:7 Comment(0)
F
0

I use restclient, available from Google Code. It's a simple Java Swing application which supports all HTTP methods, and allows you full control over the HTTP headers, conneg, etc.

Flow answered 3/10, 2008 at 10:6 Comment(0)
I
0

I tend to write unit tests for RESTful resources using Jersey which comes with a nice REST client. The nice thing is if you implement your RESTful resources using JAX-RS then the Jersey client can reuse the entity providers such as for JAXB/XML/JSON/Atom and so forth - so you can reuse the same objects on the server side as you use on the client side unit test.

For example here is a unit test case from the Apache Camel project which looks up XML payloads from a RESTful resource (using the JAXB object Endpoints). The resource(uri) method is defined in this base class which just uses the Jersey client API.

e.g.

clientConfig = new DefaultClientConfig();
client = Client.create(clientConfig);

resource = client.resource("http://localhost:8080");
// lets get the XML as a String
String text = resource("foo").accept("application/xml").get(String.class);
Isogamete answered 3/10, 2008 at 10:37 Comment(0)

© 2022 - 2024 — McMap. All rights reserved.