REST Design Examples

Introduction

Web services are client and server applications that communicate over the World Wide Web. REST (Representational State Transfer) webservices refers to an architecture style for designing networked applications.

This week was spent reading principles of REST Webservices design. To follow some examples this page demonstrates what others have done

OPENMRS

Examples and descriptions are here: OPENMRS REST Webservices
Specifically for Concepts , OpenMRS identifies the following resources:

• Concept
• ConceptClass
• ConceptDataType
• ConceptDescription
• ConceptMap
• ConceptName
• ConceptSource
  

More information here:[REST Web Service Resources in OpenMRS 1.8](https://wiki.openmrs.org/display/docs/REST+Web+Service+Resources+in+OpenMRS+1.8#RESTWebServiceResourcesinOpenMRS1.8-ConceptClass)
Limitations of the current OPENMRS REST ws are highlighted here: [Asynchronous Restful Web Service Endpoints](https://jembiprojects.jira.com/wiki/display/RHEAPILOT/Asynchronous+RestFul+Web-Service+Endpoints)

FACEBOOK

FB has an Old REST API (currently being deprecated) to allow use of the GRAPH API.

Old REST API has the following methods which is how data are retrieved

• Administrative Methods
• Login/Auth Methods
• Data Retrieval Methods
• Publishing Methods
• Facebook Connect Methods
• Mobile Methods
• Dashboard API Methods
• Events API Methods
• Custom Tags API Methods
• Ads Methods

To call on any method use the following format `https://api.facebook.com/method/method_name? access_token=oauth_access_token& arg0=value0& arg1=value1`

The Graph API is organised along functional specifications including

• Reading Data (Pictures, Selecting results, Search, Dates, Data Access)
• Publishing
• Performance
• Apps and Pages
• Games
• Others Access is through use of objects like Album, Comment etc

TWITTER

The REST API is available here Twitter API
RESOURCES are

• Timeline (collection of Tweets)
• Tweets
• Search
• Streaming
• Direct Messages
• Friends and Followers
• Users
• Suggested Users
• Favorites
• Lists
• Saved Searches
• Places & Go
• Trends
• Spam Reporting
• OAuth
• Help

ATLASSIAN

Available here: JIRA REST API
Organised in form of resources

GITHUB

Read more here : GIT API REFERENCE
Resources include

• Activity
• Issues
• Orgs
• Pill Requests
• Repositories
• Users
• Search

Other resources

• REST DESIGN PRINCIPLES