API Parameter Types
The parameters and the way the parameters are transmitted can be different in each implementation.
API parameters can be split into four different groups
The parameters and the way the parameters are transmitted can be different in each implementation.
API parameters can be split into four different groups
Often what happens is a company decides to build a new mobile app which shouldn’t directly communicate with the database. So the company builds an API for the mobile apps to communicate with the database that also does some calculations (business logic) and validations (business rules).
Over time, the business realizes that they could also potentially sell access to the API or allow their customers to directly connect with it and finally have partners launch apps in different verticals.
When we build an API, we need to keep in mind the purpose for it and that really ends up defining the type of API we have built.
Producing an API shouldn’t just be an IT only concern. Building an API could help sales, finance, marketing or even customer support. It’s common for it to start as an IT only matter and end up impacting the entire company.
Designing by software is a contract – like a legal or business contract. When we design software by contract it means we are designing against a specific specification for each software component.
The REST API will be alive for many years to come because many companies set up integrations and forget about them until there’s a problem. It is still one of the dominant types of application integrations: REST API, SOAP, and more recently GraphQL.
HATEOAS stands for Hypertext As The Engine of Application State. The theory is that by embedding enough information in our API responses it will be easier to use the API without needing to consult documentation.
When designing a REST API we need to really think of the different challenges that can occur. While many of these challenges are related to ignoring the REST API Constraints, there are definitely other issues that will pop up as you work.
Security is essential for REST APIs because our organizations depend on them.
Each resource in the REST architecture is identified by it’s Uniform Resource Identifier (URI)
These tips are based on providing a uniform interface REST constraint.
JSON is a great format for exchanging data, it’s used in almost all REST Apis for receiving and sending data.
A cheat sheet covering RESTful concepts for design and development.
The cheatsheet is one page and covers versioning, designing consistent URIs, HTTP methods, HTTP status codes, error handling and authentication/authorization.
REST APIs function primarily through the use of resources that are located at a certain URI.
Versioning is one of the most critical parts of API design. Versioning allows us to potentially make breaking changes at some point in the future.
The goal of caching is to avoid having to generate the same response twice.
In this blog article we look at five techniques for caching in a RESTful api.
A REST API is a type of API that confirms to the RESTful constraints. REST is designed to take advantage of existing protocols like HTTP.
HTTP Status Codes and HTTP Methods are the building blocks of building a good RESTful API.
REST or REpresentational State Transfer is an API architecture style that uses a uniform interface.
For an API to be RESTful there are six rules that it needs to follow.
Integration middleware is software that is used to fill the gaps between applications and databases. That means it allows remote systems to communicate with one another and even do transformations between systems.
Integrations allow businesses to potentially save a lot of money by reducing duplicate data entry, reducing licensing costs, and allowing systems to interact end to end.
APIs come in many different styles and types. Before running into a style we need to understand the different options and the trade offs that we are making.