API

Facebook Twitter

API Anti-Patterns: How to Avoid Common REST Mistakes. Web APIs typically use REST style for communication while moving away from more traditional SOAP web services.

API Anti-Patterns: How to Avoid Common REST Mistakes

Our ProgrammableWeb service directory currently lists around 1500 services which are using REST, and around 360 using SOAP. Why is REST becoming so popular and what are the common mistakes in the REST API design? Graphic from Open APIs: a State of the Market. JSON. JSON (/ˈdʒeɪsɒn/ JAY-soun, /ˈdʒeɪsən/ JAY-son), or JavaScript Object Notation, is an open standard format that uses human-readable text to transmit data objects consisting of attribute–value pairs.

JSON

It is used primarily to transmit data between a server and web application, as an alternative to XML. Although originally derived from the JavaScript scripting language, JSON is a language-independent data format, and code for parsing and generating JSON data is readily available in a large variety of programming languages. The JSON format was originally specified by Douglas Crockford. JSON. Restlet - RESTful web framework for Java. 311. Status: Maintenance JCP version in use: 2.7 Java Specification Participation Agreement version in use: 2.0 Description: This JSR will develop an API for providing support for RESTful(Representational State Transfer) Web Services in the Java Platform.

311

Please direct comments on this JSR to the Spec Lead(s) Updates to the Java Specification Request (JSR) The following information has been updated from the original JSR: Maintenance Lead: Marek Potociar. Fielding Dissertation: CHAPTER 5: Representational State Transfer (REST) [Top] [Prev] [Next] This chapter introduces and elaborates the Representational State Transfer (REST) architectural style for distributed hypermedia systems, describing the software engineering principles guiding REST and the interaction constraints chosen to retain those principles, while contrasting them to the constraints of other architectural styles.

Fielding Dissertation: CHAPTER 5: Representational State Transfer (REST)

REST is a hybrid style derived from several of the network-based architectural styles described in Chapter 3 and combined with additional constraints that define a uniform connector interface. The software architecture framework of Chapter 1 is used to define the architectural elements of REST and examine sample process, connector, and data views of prototypical architectures. 5.1 Deriving REST. RESTful Web services: The basics. The basics REST defines a set of architectural principles by which you can design Web services that focus on a system's resources, including how resource states are addressed and transferred over HTTP by a wide range of clients written in different languages.

RESTful Web services: The basics

If measured by the number of Web services that use it, REST has emerged in the last few years alone as a predominant Web service design model. In fact, REST has had such a large impact on the Web that it has mostly displaced SOAP- and WSDL-based interface design because it's a considerably simpler style to use. REST didn't attract this much attention when it was first introduced in 2000 by Roy Fielding at the University of California, Irvine, in his academic dissertation, "Architectural Styles and the Design of Network-based Software Architectures," which analyzes a set of software architecture principles that use the Web as a platform for distributed computing (see Resources for a link to this dissertation).

REST APIs must be hypertext-driven » Untangled. I am getting frustrated by the number of people calling any HTTP-based interface a REST API.

REST APIs must be hypertext-driven » Untangled

Today’s example is the SocialSite REST API. That is RPC. Protocol Extensibility and Versioning - Dave Orchard's Blog. I've argued for a while now that extensibility and versioning are important topics, and it's incredibly important for data formats to plan for evolvability .

Protocol Extensibility and Versioning - Dave Orchard's Blog

I've already argued that you must have substitution mechanisms in place for V1 , otherwise it's impossible to evolve formats. I've refined my argument that compatibility should be thought of at the the message level, and how to think about synch/asynch compatibility as combinations of compatibility of the messages that make up the message exchange pattern. But what about protocols? Restify-versions(7) - REST API Verisioning. Ietf-httpbis-p3-payload-16 - HTTP/1.1, part 3: Message Payload and Content Negotiation. RFC 5988 - Web Linking. [Docs] [txt|pdf] [draft-nottingham-...]

RFC 5988 - Web Linking

[Diff1] [Diff2] [Errata] PROPOSED STANDARD Errata Exist Internet Engineering Task Force (IETF) M. Nottingham Request for Comments: 5988 October 2010 Updates: 4287 Category: Standards Track ISSN: 2070-1721 Abstract This document specifies relation types for Web links, and defines a registry for them. S blog: Web API Versioning Smackdown. Tuesday, 25 October 2011 A lot of bits have been used over on the OpenStack list recently about versioning the HTTP APIs they provide.

s blog: Web API Versioning Smackdown

This over-long and rambling post summarises my current thoughts on the topic, both as background for that discussion, as well as for review in the wider community. The Warm-up: Software vs.