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

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.

主站蜘蛛池模板: 商丘市| 荔浦县| 道真| 和龙市| 安阳县| 张家界市| 称多县| 平原县| 五常市| 梁平县| 朝阳市| 沧州市| 日土县| 板桥市| 昆山市| 砀山县| 万盛区| 淮安市| 昌乐县| 根河市| 盘锦市| 南丰县| 黑水县| 连城县| 巴中市| 长丰县| 昌乐县| 塘沽区| 达尔| 云林县| 科技| 金塔县| 新余市| 杭锦旗| 定南县| 天等县| 临沧市| 金湖县| 江阴市| 龙陵县| 丽江市|