怎样建设美食网站,绵阳做网站多少钱,图文广告开店培训班,怎么进入wordpress的后台RESTFul规范RESTFul是一种HTTP API接口规范#xff0c;只要满足的RESTFul规范#xff0c;即可称为RESTFul API。既然是接口#xff0c;我们先来了解一下#xff0c;他和传统的API接口有何不同吧。本文以尽量简单明了的文字来介绍、描述#xff0c;只讲核心内容#xff0c…RESTFul规范RESTFul是一种HTTP API接口规范只要满足的RESTFul规范即可称为RESTFul API。既然是接口我们先来了解一下他和传统的API接口有何不同吧。本文以尽量简单明了的文字来介绍、描述只讲核心内容仅供入门指引。1 与传统API的区别RESTFul世界中一切皆抽象为资源(Resource)。用户是资源文章是资源、评论是资源抽象一点的session、token等均是资源。下面例子我们通过以下几个常用的HTTP方法对资源(图书)进行操作。RESTFul中操作 方法 示例查询 GET GET /books增加 POST POST /books修改 PUT PUT /books删除 DELETE DELETE /books传统API中操作 方法 示例查询 GET GET /api/book/getBook增加 POST POST /api/book/addBook修改 POST POST /api/book/updateBook删除 GET/POST POST /api/book/deleteBook2 URL设计RESTFul API规范很简单关键只需满足这一点。动词(HTTP动作) 名词(资源)2.1 常用动作通常我们采用以下5种 HTTP方法(动作)。GET查询(Read)POST增加(Create)PUT更新(Update)PATCH部分更新不常用(Update)DELETE删除(Delete)2.2 名词尽量复数名词尽量采用复数(语义更明确但并不强制)举个例子类型 操作 示例单数 获取所有图书 GET /book单数 获取ID为1的图书 GET /book/1复数 获取所有图书 GET /books复数 获取ID为1的图书 GET /books/1不难发现复数形式语义更明确。2.3 方法 过滤参数方法应当以路径(path)的方式传递示例获取部门GET /departments获取部门下的所有员工GET /departments/{id}/employees获取部门下的某个员工GET /departments/{id}/employees/{id}文章点赞PUT /articles/{id}/praise过滤参数应当以查询字符串(QueryString)的方式传递示例获取第1页每页显示10条GET /books?page1per_page10获取已经发布的文章GET /articles?publishedtrue(或等于1也行)何时使用方法何时使用过滤参数区别方法获取后的数据结构不同了。过滤参数获取后的数据结构还是一样的只是数量减少了。3 响应请求必须尽可能返回意义准确的HTTP状态码不要一味的返回200状态码。状态码主要分为5类在RESTFul中通常我们只需要用到2XX、4XX、5XX。1XX信息类2XX成功类3XX重定向4XX客户端错误5XX服务器错误有关状态码的详细参考HTTP状态码常用HTTP状态码响应码 说明200 OK 请求已成功201 Created 资源已创建204 No Content 请求已成功但无返回内容304 Not Modified 缓存有效400 Bad Request 语义有误当前请求无法被服务器理解请求参数错误401 Unauthorized 当前请求需要用户认证(登录)403 Forbidden 用户已认证(登录)但权限不足404 Not Found 请求源未在服务器上被发现405 Method Not Allowed 请求方法不能被用于请求相应的资源如使用PUT方法访问只接受POST方法的API500 Internal Server Error 服务端内部错误502 Bad Gateway 网关错误504 Gateway Timeout 网关超时3.1 成功类对于成功类除了GET请求需要返回响应体(数据)之外其他请求均可不返回响应体。获取文章返回200状态码返回的数据不需要进行多余的包装。GET /articles/1HTTP/1.1 200 OK{title: 文章标题,content: 文章内容}增加文章返回201状态码可选返回响应体(创建后的对象)。POST /articlesHTTP/1.1 201 Created{id: 1,title: 文章标题,content: 文章内容}HTTP/1.1 201 Created更新文章若返回响应体(更新后的对象)则使用200状态码否则使用204状态码。PUT /articles/1HTTP/1.1 200 OK{id: 1,title: 文章标题,content: 文章内容}HTTP/1.1 204 No Content删除文章返回204状态码。DELETE /articles/1HTTP/1.1 204 No Content3.2 错误类建议为所有错误的请求响应体加上错误代码、消息字段。错误代码建议由HTTP状态码 自定义的错误代码组成。例如客户端错误状态码为400账号或密码错误代码为01(自定义)组成40001错误代码。3.2.1 客户端错误登录失败POST /tokens/loginHTTP/1.1 400 Bad Request{error_code: 40001,message: 用户名或密码错误}用户名已被注册POST /usersHTTP/1.1 400 Bad Request{error_code: 40002,message: 用户名已被注册}未登录HTTP/1.1 401 Unauthorized{error_code: 40101,message: 用户未登录}权限不足HTTP/1.1 403 Forbidden{error_code: 40301,message: 权限不足}文章不存在或已被删除HTTP/1.1 404 Not Found{error_code: 40401,message: 文章不存在或已被删除}3.2.2 服务器错误HTTP/1.1 500 Internal Server Error{error_code: 50001,message: 服务器内部错误请稍后再试或联系管理员}wordpress rest api ReferenceREST API Developer Endpoint Reference #REST API Developer Endpoint ReferenceResource Base RoutePosts /wp/v2/postsPost Revisions /wp/v2/posts//revisionsCategories /wp/v2/categoriesTags /wp/v2/tagsPages /wp/v2/pagesPage Revisions /wp/v2/pages//revisionsComments /wp/v2/commentsTaxonomies /wp/v2/taxonomiesMedia /wp/v2/mediaUsers /wp/v2/usersPost Types /wp/v2/typesPost Statuses /wp/v2/statusesSettings /wp/v2/settingsThemes /wp/v2/themesSearch /wp/v2/searchBlocks /wp/v2/blocksBlock Revisions /wp/v2/blocks//autosaves/Block Renderer /wp/v2/block-renderer以上转自www.jianshu.com/p/843a524dd88f 作者izhouteng更多阅读资料REST API手册WordPress Rest API 最细接口详解