TheCloneArmy/RestApiGuide
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added previous/next links to lessons pages.

Browse Source
This commit is contained in:
Todd Fredrich
2012-06-18 11:41:27 -06:00
parent c4cc30f78c
commit 559a3ece51
4 changed files with 33 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
index.html
View File

@ -40,8 +40,8 @@
<h1>Learn REST: A RESTful Tutorial</h1>
<p>Building restful web services, like other programming skills is <strong>part art, part science</strong>. As the Internet industry progresses, creating a REST API becomes more concrete, with emerging best practices. As RESTful Web services don't follow a prescribed standard except for HTTP, it's important to build your RESTful API in accordance with industry best practices to ease development and simplify client adoption.</p>
<p>Presently, there aren't a lot of REST API guides to help the lonely developer. <a href="http://www.restapitutorial.com">RestApiTutorial.com</a> is dedicated to tracking REST API best practices and making resources available to enable quick reference and self education for the development crafts-person. We'll discuss both the art and science of creating REST Web services.</p>
<p>Jump in with <a href="restquicktips.html">REST API Quick Tips</a>, a few overarching concepts (based on <a href="http://37signals.com/svn/posts/3018-api-design-for-humans" target="_blank">this post</a> from <a href="http://www.37signals.com" rel="nofollow" target="_blank">37 Signals</a>) created to get you started on the right track.</p>
<p><a class="btn btn-primary btn-large" href="restquicktips.html">Get Started &raquo;</a></p>
<p>Jump in with <a href="lessons/whatisrest.html">What Is REST?</a>, an overview concepts and constraints of the RESTful architecture.</p>
<p><a class="btn btn-primary btn-large" href="lessons/whatisrest.html">Get Started &raquo;</a></p>
</div>
<!-- <div class="row">
<div class="span3">

14
lessons/httpmethods.html
View File

@ -36,13 +36,23 @@
<body>
<div class="container">
<div class="row">
<div class="span12">
<div class="span8">
<h1>Using HTTP Methods for RESTful Services</h1>
<p>The HTTP verbs comprise a major portion of our “uniform interface” constraint and provide us the action counterpart to the noun-based resource. The primary or most-commonly-used HTTP verbs (or methods, as they are properly called) are POST, GET, PUT, and DELETE. These correspond to create, read, update, and delete (or CRUD) operations, respectively. There are a number of other verbs, too, but are utilized less frequently. Of those less-frequent methods, OPTIONS and HEAD are used more often than others.</p>
</div>
<div class="span4">
<ul class="pager">
<li>
<a href="restquicktips.html"><i class="icon-step-backward"></i> Previous</a>
</li>
<li>
<a href="../httpstatuscodes.html">Next <i class="icon-step-forward"></i></a>
</li>
</ul>
</div>
</div>
<div class="row">
<div class="span12">
<p>The HTTP verbs comprise a major portion of our “uniform interface” constraint and provide us the action counterpart to the noun-based resource. The primary or most-commonly-used HTTP verbs (or methods, as they are properly called) are POST, GET, PUT, and DELETE. These correspond to create, read, update, and delete (or CRUD) operations, respectively. There are a number of other verbs, too, but are utilized less frequently. Of those less-frequent methods, OPTIONS and HEAD are used more often than others.</p>
<p>Below is a table summarizing recommended return values of the primary HTTP methods in combination with the resource URIs:</p>
<table class="table table-striped table-bordered">
<thead>

16
lessons/restquicktips.html
View File

@ -36,8 +36,22 @@
<body>
<div class="container">
<div class="row">
<div class="span12">
<div class="span8">
<h1>REST API Quick Tips</h1>
</div>
<div class="span4">
<ul class="pager">
<li>
<a href="whatisrest.html"><i class="icon-step-backward"></i> Previous</a>
</li>
<li>
<a href="httpmethods.html">Next <i class="icon-step-forward"></i></a>
</li>
</ul>
</div>
</div>
<div class="row">
<div class="span12">
<p>Whether it's technically RESTful or not (according to the six constraints mentioned above), here are a few recommended REST-like concepts that will result in better, more usable services:</p>
<h2>Use HTTP Verbs to Mean Something</h2>
<p>Any API consumer is capable of sending GET, POST, PUT, and DELETE verbs, and they greatly enhance the clarity of what a given request does. Also, GET requests must not change any underlying resource data. Measurements and tracking may still occur, which updates data, but not resource data identified by the URI.</p>

8
lessons/whatisrest.html
View File

@ -36,16 +36,16 @@
<body>
<div class="container">
<div class="row">
<div class="span10">
<div class="span8">
<h1>What Is REST?</h1>
</div>
<div class="span2">
<div class="span4">
<ul class="pager">
<li>
<a href="#">Previous</a>
<a href="../index.html"><i class="icon-step-backward"></i> Previous</a>
</li>
<li>
<a href="#">Next</a>
<a href="restquicktips.html">Next <i class="icon-step-forward"></i></a>
</li>
</ul>
</div>