Skip to content

Commit

Permalink
Including REST references
Browse files Browse the repository at this point in the history
  • Loading branch information
newtoncalegari committed May 4, 2016
1 parent 7ec5e4c commit 4a7e0e0
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
3 changes: 2 additions & 1 deletion bp.html
Expand Up @@ -3135,7 +3135,8 @@ <h4 class="subhead">Intended Outcome</h4>
<section class="how">
<h4 class="subhead">Possible Approaches to Implementation</h4>
<p>REST (REpresentational State Transfer) is an architectural style that, when used in a Web API, takes advantage of the architecture of the Web itself. A full discussion of how to build a RESTful API is beyond the scope of this document, but there are many resources and a strong community that can help in getting started. There are also many RESTful development frameworks available. If you are already using a Web development framework that supports building REST APIs, consider using that. If not, consider an API-only framework that uses REST.</p>
<p>Another aspect of implementation to consider is making a hypermedia API, one that responds with links as well as data. Links are what make the Web a web, and data APIs can be more useful and usable by including links in their responses. The links can offer additional resources, documentation, and navigation. Even for an API that does not meet all the constraints of REST, returning links in responses can make for a service that is rich and self-documenting. </p>
<p>Another aspect of implementation to consider is making a hypermedia API, one that responds with links as well as data. Links are what make the Web a web, and data APIs can be more useful and usable by including links in their responses. The links can offer additional resources, documentation, and navigation. Even for an API that does not meet all the constraints of REST, returning links in responses can make for a service that is rich and self-documenting.</p>
<p>Complementary references about REST are [[Fielding]] and [[Richardson]].</p>
<aside class="example">An example response for information about a certain bus route from a hypermedia API might look like the following:
<pre> {
"code": "200",
Expand Down
14 changes: 14 additions & 0 deletions bpconfig.js
Expand Up @@ -223,6 +223,20 @@ var respecConfig = {
"title": "Study On Persistent URIs",
"date": "17 December 2012"
},
"Richardson": {
"authors": ["Richardson L.", "Sam Ruby"],
"href": "http://restfulwebapis.org/rws.html",
"title": "RESTful Web Services",
"date": "2007",
"publisher": "O'Reilly"
},
"Fielding": {
"authors": ["Roy Thomas Fielding"],
"title": "Representational State Transfer (REST), Chapter 5 of Architectural Styles and the Design of Network-based Software Architectures",
"href": "https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm",
"publisher": "University of California, Irvine",
"date": "2000"
},
"SIRI":{
"authors":["CEN"],
"href": "http://user47094.vs.easily.co.uk/siri/",
Expand Down

0 comments on commit 4a7e0e0

Please sign in to comment.