Today you may hear about restful api alot. But do you know what is a rest api? How can you implement a rest api? what are the rules of creating one? In this repository we are going to talk about restful api and its principles.
An API, or application programming interface, is a set of rules that define how applications or devices can connect to and communicate with each other. A Restful API is an API that conforms to the design principles of the REST, or representational state transfer architectural style.
REST APIs add no new capability to HTTP APIs. But it is an architectural style that was created in tandem with HTTP and most typically employs HTTP as its application layer protocol. However, REST isn't always linked to HTTP. You can use other transfer protocols, such as FTP, SMTP, etc.
The REST architecture allows API providers to deliver data in multiple formats such as plain text, HTML, XML, YAML, and JSON, which is one of its most loved features.
The six guiding principles or constraints of the Restful architecture are:
- Uniform Interface
- Client-Server
- Stateless
- Cacheable
- Layered System
- Code on Demand (Optional)
REST stands for Representational State Transfer. This means that when a client requests a resource using a REST API, the server transfers back the current state of the resource in a standardized representation.
The key abstraction of information in REST is a resource. Any information that we can name can be a resource. For example, a REST resource can be a document or image, a temporal service, a collection of other resources, or a non-virtual object (e.g., a person).
Building a Restful API with python fastapi library. Enter into fastapi directory and start api server:
uvicorn main:app --reloadCheck api version:
curl -w '\n' localhost:8000/apiInsert a device:
curl -w '\n' -X POST -H "Content-Type: application/json" --data '{"version": 0.5, "platform": "IOS"}' localhost:8000/api/deviceGet the list of devices:
curl -w '\n' localhost:8000/api/deviceUpdate a device:
curl -w '\n' -X PUT -H "Content-Type: application/json" --data '{"version": 0.1, "platform": "IOS"}' localhost:8000/api/device/10002Delete a device:
curl -w '\n' -X DELETE localhost:8000/api/device/10002