background preloader

RESTful

Facebook Twitter

If REST applications are supposed to be stateless, how do you manage sessions? How to manage state in REST. Anypoint Platform for APIs. C10k: Developing non-blocking REST services with Spring MVC. In this blog we will show you how to develop non-blocking REST services using Spring MVC.

C10k: Developing non-blocking REST services with Spring MVC

We will also demonstrate the vast difference in scalability that non-blocking services provide compared to traditional blocking services. We will use Spring Boot to create a web app for deployment in a Servlet 3.0 compliant web-server and Gradle to build and execute the web app. Finally we will use Gatling to load test the REST services. Spring MVC REST Exception Handling Best Practices (part 1)

If you’re already using Spring to build your application, and you need to serve a ReST API, Spring MVC can be a good choice to write your REST endpoints.

Spring MVC REST Exception Handling Best Practices (part 1)

However, representing errors or problems cleanly in a RESTful way may not be immediately obvious since Spring MVC is so often referenced for building user interfaces. Because there is no direct UI concept in REST APIs, how then do you use Spring MVC to represent errors or problems in a clean and intuitive way? This article is Part 1 of a 2 part series. In this article, we’ll cover RESTful error reporting best practice conventions. Part 2 will show how to implement them with Spring MVC in a complete example web application.

RESTful Error Design If an error occurs, RESTful practices expect that we set an HTTP status code in the response to generally classify why the request failed. To best help your REST API customers, you ideally want to give them as much information as possible to help them diagnose and hopefully fix the problem. Status. RESTful API Design: what about errors? In the previous posts in this series about Pragmatic REST API design, I talked about simplyfing associations, using the HTTP ?

RESTful API Design: what about errors?

To hide complexities and optional parameters, choosing plural nouns and concrete names, and more. See the series here. What about errors in the context of RESTful API best practices? Many software developers, including myself, don't always like to think about exceptions and error handling but it is a very important piece of the puzzle for any software developer, and especially for API designers. Why is good error design especially important for API designers? Bottom line, it's about making your APIs intuitive and making developers successful. First, developers learn to write code through errors. From the perspective of the developer consuming your Web API, everything at the other side of that interface is a black box. YouTube. Api-design-ebook-2012-03.pdf. API Design: Harnessing HATEOAS, Part 1. Previously, we discussed HATEOAS (the hypermedia constraint) within the context of REST.

API Design: Harnessing HATEOAS, Part 1

This laid the groundwork for our discussion today, which is how to apply HATEOAS to an API strategy. Now, let’s look at some questions people have in regard to HATEOAS when setting up their API. What does it mean to be compliant with HATEOAS? Best Practices for Designing a Pragmatic RESTful API. Your data model has started to stabilize and you're in a position to create a public API for your web app.

Best Practices for Designing a Pragmatic RESTful API

You realize it's hard to make significant changes to your API once it's released and want to get as much right as possible up front. Now, the internet has no shortage on opinions on API design. Get developer hugs with rich error handling in your API. Server-side error handling and communication are major, often under-appreciated components in designing a REST API.

Get developer hugs with rich error handling in your API

Most API developers spend their time on everything else involved in getting a REST API done right — from debating which resources need to be exposed through the API, to getting the HTTP verbage right, to using content negotiation. Unfortunately, error responses tend to be an after-thought. They're treated as second-class citizens whose design never gets reviewed nor discussed as actively as any another component of the API. The fact is that although errors only account for a fraction of all messages sent by the API (at least typically), they are the most scrutinized messages by app developers.

(Even more than success response messages!) C10k: Developing non-blocking REST services with Spring MVC. Anypoint Platform. Tutorial - REST API design and implementation with Jersey and Spring. Looking to REST in Java?

Tutorial - REST API design and implementation with Jersey and Spring

Then you’ve come to the right place, because in the blog post I will present you how to “beautifully” design a REST API and also, how to implement it in Java with the Jersey framework. The RESTful API developed in this tutorial will demonstrate a complete Create,_read,_update_and_delete (CRUD) functionality for podcast resources stored in a MySql database. 1. RESTful Web Services Example in Java with Jersey, Spring and MyBatis. Note: At the time of writing this post I was just starting with REST and Jersey so I suggest you have a look at Tutorial – REST API design and implementation in Java with Jersey and Spring instead.

RESTful Web Services Example in Java with Jersey, Spring and MyBatis

How do I let users log into my RESTful API? I want users to login into my RESTful API so only they can see (protected) resources.

How do I let users log into my RESTful API?

What is the correct way to do this? One of the main differences between RESTful and other server-client communications services is that any session state in a RESTful setup is held in the client, the server is stateless. This requires the client to provide all information necessary to make the request. Using HTTP basic authentication.

Create your own REST API Using OAuth Authentication. As a result of more and more information being available online, information sharing between websites has become widespread.

Create your own REST API Using OAuth Authentication

Learn REST: A Tutorial. A server response in REST is often an XML file; for example, <parts-list><part id="3322"><name>ACME Boomerang</name><desc> Used by Coyote in <i>Zoom at the Top</i>, 1962 </desc><price currency="usd" quantity="1">17.32</price><uri> id="783"><name>ACME Dehydrated Boulders</name><desc> Used by Coyote in <i>Scrambled Aches</i>, 1957 </desc><price currency="usd" quantity="pack">19.95</price><uri> However, other formats can also be used; unlike SOAP services, REST is not bound to XML in any way. Possible formats include CSV (comma-separated values) and JSON (JavaScript Object Notation). Each format has its own advantages and disadvantages.

XML is easy to expand (clients should ignore unfamiliar fields) and is type-safe; CSV is more compact; and JSON is trivial to parse in JavaScript clients (and easy to parse in other languages, too). Untitled. All of our examples will be based on Spring Boot. We’ll reprint the same setup code for each example. Our example models a simple bookmark service, à la Instapaper or other cloud-based bookmarking services. Our bookmark service simply collects a URI, and a description. All bookmarks belong to a user account.