I have created a sample REST API in this post. To access any API service, You need to write REST client code in your application. But you can try out any API services in your browser itself, by installing one of the many available tools. Good REST client tools is available for both Firefox and Chrome. I will explain, installing one of the tool and how to use it in Firefox.
RESTClient is a debugger for RESTful web services. Currently only Firefox addon has been finished. Changes Firefox Addon. Version 3.0.6 Added Chinese locale. Added an instruction for add self signed web site to certificates exception list. Use Postman's API client to create and save REST, SOAP, and GraphQL queries. Send requests, inspect responses, and easily debug APIs.
STEP 1 : Installing the REST client tool
=> open your Firefox browser
=>You can find the REST client tool, through below steps
click tool tab at top of browser -> click web developer from the list -> click get more tools ->click Extensions down the adds on tab -> search rest client -> install the one with the title : RESTClient, a debugger for RESTful web services by click the button add to Firefox
=> Once installed, you can see a brown square icon with a circle in it at top right hand side of the browser. click it to start the tool
STEP 2: Understanding the tool
The REST client UI in browser look like this
You can test any REST API with the above tool. To use any API, you need to have information about its various services, see the sample API created in this post and read its documentation. These are the things, you need to fill up in the above UI, before making a call.
Authorization :
It list various type of authorization you need to setup before accessing any API. In the sample API I have provided basic authorization with username and password. Thus, click on basic authorization, fill the username and password and click O.K. It is one time process and will set your authorization for the current session
Content Type :
You need to setup, the content type of your request body. In API documentation you can find various type of content type supported by it. You can set content type by : click on header -> click on custom header -> In the popup, fill up Content-Type in name field and application/xml or application/json or application/x-www-form-urlencoded or anyother as per your need in the value field-> click O.K
This can be also a one time process and you do not need to change it untill, you want to try out with any other content type.
API Requests :
Set, proper method, url and body in the above Rest Client UI as specified by the API documentation and then click the send button
API Response :
Once, the request is completed, you can see Response tab appearing at the bottom with Header, Response Body(raw), Response Body(highlight), Response Body(Preview). The Header will contain the status of the response i,e success or failed and the response body will contain the data returned by the API to you
Responsive Patterns, automatic jQuery app tester, RESTCLient for debugging RESTful web services are just some of the things Mozilla’s Developer Engagement team want to recommend to you this week!
Weekly links
If there is anything you think we should read or know about, don’t hesitate to post a comment, contact us on Twitter or through any other means.
The picks this week are:
- Responsive Patterns – A collection of patterns and modules for responsive designs
- Burrito Bomber – The world’s first airborne Mexican food delivery system
- walkabout.js – An automatic jQuery app tester
- RESTClient – a debugger for RESTful web services
The Developer Engagement team
Mozilla’s Developer Engagement team work with writing articles, documentation – such as MDN (Mozilla Developer Network) – public speaking and generally helping and informing about open technologies and Mozilla products. If you are interested in following our work, here are the team members:
Restful Web Services Netbeans
- Havi Hoffman (@freshelectrons).
About Robert Nyman [Editor emeritus]
Restclient A Debugger For Restful Web Services For Firefox Download
Technical Evangelist & Editor of Mozilla Hacks. Gives talks & blogs about HTML5, JavaScript & the Open Web. Robert is a strong believer in HTML5 and the Open Web and has been working since 1999 with Front End development for the web - in Sweden and in New York City. He regularly also blogs at http://robertnyman.com and loves to travel and meet people.