ToddFredrich.com RESTful/Platform APIs and Examples, Tutorials and the Software Craft. Mostly…

9Jan/130

Instant REST Services with RESTExpress Q&A

Posted by Todd

This is a follow-on to my last two posts, Introduction to REST (Revisited) and RESTExpress Overview and Tutorial, with this short video being the Q&A after the presentation.  In it, the video talks about authentication, authorization, and some of the RESTExpress features around sorting, filtering and performance.  It's a quickie, but it's always nice to understand what others are asking... and some answers to those questions.

[youtube http://youtu.be/z5u4rZTK8o0]
7Jan/130

RESTExpress Overview and Tutorial

Posted by Todd

In my last post, Intro to REST (Revisited), as well as discussing the six constraints of the REST architectural style, the video discussed the background for the Java Rest Service Framework, RESTExpress and introduces a sample project.  The video below is part two of the presentation, where we dive in and create a real, working service suite using RESTExpress around a blogging system that uses MongoDB for its back-end store.  The reference implementation demo'd during the presentation is available on GitHub and supports linking, pagination, filtering and sorting of collection results returned (for blogs, entries, and comments).

This video goes into a bit of depth on how all that gets accomplished in your service suites with a minimum of coding.

[youtube http://youtu.be/hHDO6soGehc]

 

If you haven't heard, RESTExpress is a lightweight micro-framework (along with some other micro-frameworks) that support rapid development of highly scalable, high performance REST services supporting JSON and XML payloads.  It is an active open source project that is gaining momentum.  You can get more information at the resources below:

4Jan/131

Introduction to REST (Revisited)

Posted by Todd

I get a lot of questions around RESTful practices and I see a lot of confusion out there in REST API land about what REST really means, is, and how to implement it.  Last November 2012, I talked at the Pearson Technology Summit in Denver, Colorado.  The talk is entitled "Instant REST Services with RESTExpress" but spends some time during the first have to revisit the six REST architectural constraints.  While the lapel mic was giving me troubles and causing some noise on the recording, the content is definitely understandable.  Enjoy.

[youtube http://youtu.be/XcNDRr5zaI0]

 

The Six Constraints of the RESTful Architectural Style are:

  • Uniform Interface
  • Stateless
  • Client-Server
  • Layered System
  • Cacheable
  • Code on Demand
2Jan/130

How To Design A Good API And Why It Matters

Posted by Todd

In 2006 (yes, before the RESTful era), Joshua Bloch gave a talk entitled "How to Design a Good API and Why It Matters."  While it's not directly applied to RESTful design, Joshua's list of "Characteristics of a Good API" is extremely applicable.  Watch the YouTube video below to hear the talk (this one's from 2007).  My own summary of important points is at the bottom of the post.

Here is a brief checklist summarizing Joshua's "Characteristics of a Good API":

  • Easy to Learn
  • Easy to use, documented or not
  • Hard to use incorrectly
  • Easy to read, understand and maintain the code that uses it
  • Just enough power to satisfy requirements
  • Easily extensible
  • Appropriate for the audience