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

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.

主站蜘蛛池模板: 浙江省| 宣城市| 大港区| 绍兴市| 平定县| 佛冈县| 云和县| 黔西县| 洛扎县| 博客| 紫金县| 新河县| 东阿县| 威远县| 乌拉特后旗| 白河县| 文安县| 鄂托克前旗| 普安县| 三台县| 萍乡市| 涡阳县| 揭西县| 丰顺县| 宜良县| 大竹县| 衡东县| 宁远县| 大埔县| 都昌县| 商都县| 南京市| 德惠市| 镇平县| 武宣县| 五河县| 祁阳县| 商都县| 隆安县| 隆化县| 尼木县|