
The attributes tell what the object contains and what information can be taken from that object. The key value pairs that JSON holds are keys, and it is these keys are attributes that represent the object being described. Lets talk about the data that is represented by JSON. This is a reason why JSON has become so popular because the use of key value pairs makes it easy for both computers to understand that data stored in the key value pairs. The process of step 1 – dealing with data formats – is to make sure that the data has been put into a language that one computer can send to another that will understand that data. What can drive this decision is one that you should consider in the eyes of the audience because it is the data format that will dictate how the information is understood and what is the easiest way for that data to be handled by those who are making use of the API. JSON has become so popular because of the ease of use with the data that is past back and forth to and from the API. These days the most popular data formats are JSON, but the use of XML is also an option. How the data is represented with be the decision maker on how your API is structured overall and how it will handle the requests and responses. One of the first decisions when designing your API is the data format that will represent the API. This post is to help you in this decision making process from the start to end of the design of the API, which leaves it up to you on how you implement your API and offer it for consumption by others that want to take advantage of the data that is offered from the API that you have created and designed.


Without having a good strategic plan in place from the beginning can make it difficult to sustain the API over time. The design of an API has different design phases and decision making that will determine how well your API is designed and the usability of your API. This article was authored by Codementor Rob Simpson and originally posted at his blog.

REST is an architecture style for designing networked applications, and an API that adheres to the principles of REST does not require the client to know anything about the structure of the API.
#Electron api best practices how to#
It will explain in detail data formats, architectural decisions, and how to implement real-time communication into your API. This guide is a step-by-step approach to designing a RESTful API using best practices.
