rest api如何创建
资源创建是常见的REST API操作。 在这篇文章中,我们将看到如何创建单个资源。
客户要求
通常,通过将POST请求发送到父集合资源来创建资源。 这将使用新生成的ID创建一个新的下属资源。
例如,对/ projects的POST请求可用于在/ projects / 123处创建新的项目资源。
POST是幂等的,因此,如果多次发出同一请求,则可以创建多个资源。 (如果您不知道什么是幂等,请查看我有关幂等和安全的文章 )。
在极少数情况下,如果客户端能够生成资源ID,则也有可能使用PUT进行资源创建。 例如,在这种情况下,我们可以使用PUT / projects / <id>创建一个新项目。
客户端还必须发送以下标头:
- 用于指定请求主体的媒体类型的Content-Type
- 接受以定义支持的响应格式。 即使服务器不返回新创建的资源,也应发送此标头。 如果资源创建失败,它允许服务器发送详细的错误信息。
范例要求
POST /projects Content-Type: application/json Accept: application/json {
"name" : "My cool project" ,
"description" : "Bla bla .." }
服务器响应
成功创建资源后,服务器应使用HTTP 201(已创建)进行响应。 响应还应该具有一个Location标头,其中包含新创建的资源的URI。 需要时,响应主体可以包含创建的资源。 在这种情况下,还需要Content-Type标头。
回应范例
HTTP/ 1.1 201 Created Location: /projects/ 123 Content-Type: application/json {
"id" : 123 ,
"name" : "My cool project" ,
"description" : "Bla bla .." }
翻译自: https://www.javacodegeeks.com/2020/07/rest-creating-resources.html
rest api如何创建