Building a successful API - Understanding Open api specification (OAS) 3.0

Building a successful API - Understanding Open API Specification (OAS) 3.0

The Open API Specification is used to define the contract between the API consumers and the API providers. The specification is based on the JSON schema and is a standard format for describing the data exchanged between the API consumers and the API providers.

June 20, 2020 · 7 min · 1358 words · Pradeep Loganathan
REST constraints

REST - Identifying Resources and URI design.

The key parts of a Resource oriented architecture (REST architecture) are resources, identifiers, representations, and the links between them. There is no exact science to identifying resources and there is no right or wrong with resources identified.In this post we will look at best practices to do so.

December 14, 2016 · 5 min · 1008 words · Pradeep Loganathan

Richardson's Maturity Model

The Richardson Maturity Model was developed by Leonard Richardson . It specifies a model to grade REST services according to their adherence to the REST constraints. This model identifies three levels of service maturity based on the service’s support for URI’s, HTTP and Hypermedia. Level Zero Services – Level zero services are characterized by services having only one URI and using a single request type mainly POST. The message contains both the operation to be performed and the data needed for that operation....

October 21, 2016 · 2 min · 400 words · Pradeep Loganathan
Rest - Idempotency and Safety

Rest - Idempotency and Safety

Implementing the REST architectural principles results in the both Idempotency and safety being incorporated into the system. This is not however not completely automatic and needs to be thought through in detail.

October 19, 2016 · 4 min · 844 words · Pradeep Loganathan
REST constraints

REST architectural constraints

REST defines six architectural constraints which make any web service – a truly RESTful API. These are also called as Fielding’s constraints. They generalize the Web’s architectural principles and represent them as a framework of constraints or an architectural style.

October 19, 2016 · 4 min · 710 words · Pradeep Loganathan