官术网_书友最值得收藏!

REST verbs and status codes

REST verbs specify an action to be performed on a specific resource or a collection of resources. When a request is made by the client, it should send this information in the HTTP request:

  • REST verb
  • Header information
  • Body (optional)

As we mentioned previously, REST uses the URI to decode its resource to be handled. There are quite a few REST verbs available, but six of them are used frequently. They are as follows:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
  • OPTIONS

If you are a software developer, you will be dealing with these six most of the time. The following table explains the operation, target resource, and what happens if the request succeeds or fails:

The numbers in the Success and Failure columns of the preceding table are HTTP status codes. Whenever a client initiates a REST operation, since REST is stateless, the client should know a way to find out whether the operation was successful or not. For that reason, HTTP has status codes for the response. REST defines the preceding status code types for a given operation. This means a REST API should strictly follow the preceding rules to achieve client-server communication.

All defined REST services have the following format. It consists of the host and API endpoint. The API endpoint is the URL path which is predefined by the server. Every REST request should hit that path.

A trivial REST API URI: http://HostName/API endpoint/Query(optional)

Let us look at all the verbs in more detail. The REST API design starts with the defining of operations and API endpoints. Before implementing the API, the design document should list all the endpoints for the given resources. In the following section, we carefully observe the REST API endpoints using PayPal's REST API as a use case.

主站蜘蛛池模板: 油尖旺区| 确山县| 马尔康县| 古丈县| 洪泽县| 翁牛特旗| 平度市| 农安县| 平乐县| 西充县| 丰都县| 高台县| 东丰县| 高密市| 怀柔区| 富锦市| 滁州市| 拜泉县| 天柱县| 鄄城县| 清镇市| 十堰市| 红安县| 阿克陶县| 彭泽县| 宣武区| 陆河县| 泰和县| 富川| 中阳县| 喀什市| 桂东县| 屏山县| 望江县| 霍州市| 塔城市| 宜宾县| 特克斯县| 孟州市| 彭阳县| 秭归县|