Skip to content
This repository has been archived by the owner on Mar 3, 2022. It is now read-only.

Commit

Permalink
Merge pull request #24 from philipashlock/patch-1
Browse files Browse the repository at this point in the history
Specifying HTTP verb (GET) on other Good URL examples for consistency
  • Loading branch information
TravisCarden committed Oct 31, 2013
2 parents 82d0a80 + b6bf945 commit 3b8ff8c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Expand Up @@ -47,18 +47,18 @@ These guidelines aim to support a truly RESTful API. Here are a few exceptions:

### Good URL examples
* List of magazines:
* http://www.example.gov/api/v1/magazines.json
* GET http://www.example.gov/api/v1/magazines.json
* Filtering is a query:
* http://www.example.gov/api/v1/magazines.json?year=2011&sort=desc
* http://www.example.gov/api/v1/magazines.json?topic=economy&year=2011
* GET http://www.example.gov/api/v1/magazines.json?year=2011&sort=desc
* GET http://www.example.gov/api/v1/magazines.json?topic=economy&year=2011
* A single magazine in JSON format:
* http://www.example.gov/api/v1/magazines/1234.json
* GET http://www.example.gov/api/v1/magazines/1234.json
* All articles in (or belonging to) this magazine:
* http://www.example.gov/api/v1/magazines/1234/articles.json
* GET http://www.example.gov/api/v1/magazines/1234/articles.json
* All articles in this magazine in XML format:
* GET http://example.gov/api/v1/magazines/1234/articles.xml
* Specify optional fields in a comma separated list:
* http://www.example.gov/api/v1/magazines/1234.json?fields=title,subtitle,date
* GET http://www.example.gov/api/v1/magazines/1234.json?fields=title,subtitle,date
* Add a new article to a particular magazine:
* POST http://example.gov/api/v1/magazines/1234/articles

Expand Down

0 comments on commit 3b8ff8c

Please sign in to comment.