以豆瓣网为例,讲解restful api设计规范

2024-06-23 15:18

本文主要是介绍以豆瓣网为例,讲解restful api设计规范,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

什么是restful api

目前比较成熟的一套互联网应用程序的API设计理论

豆瓣电影api

  1. 应该尽量将API部署在专用域名之下
    http://api.douban.com/v2/user/1000001?apikey=XXX

  2. 应该将API的版本号放入URL
    http://api.douban.com/v2/user/1000001?apikey=XXX

  3. 在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的”集合”(collection),所以API中的名词也应该使用复数。
    http://api.douban.com/v2/book/:id (获取图书信息)
    http://api.douban.com/v2/movie/subject/:id (电影条目信息)
    http://api.douban.com/v2/music/:id (获取音乐信息)
    http://api.douban.com/v2/event/:id (获取同城活动)

  4. 对于资源的具体操作类型,由HTTP动词表示。常用的HTTP动词有下面四个(对应增/删/改/查)。
    GETselect):从服务器取出资源(一项或多项)。
    eg. 获取图书信息 GET http://api.douban.com/v2/book/:id\

    POSTcreate):在服务器新建一个资源。
    eg. 用户收藏某本图书 POST http://api.douban.com/v2/book/:id/collection

    PUTupdate):在服务器更新资源(客户端提供改变后的完整资源)。
    eg. 用户修改对某本图书的收藏 PUT http://api.douban.com/v2/book/:id/collection

    DELETEdelete):从服务器删除资源。
    eg. 用户删除某篇笔记 DELETE http://api.douban.com/v2/book/annotation/:id

  5. 如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果

    ?limit=10:指定返回记录的数量*
    eg. 获取图书信息 GET http://api.douban.com/v2/book/:id?limit=10

  6. 服务器向用户返回的状态码和提示信息
    每个状态码代表不同意思, 就像代号一样

    2系 代表正常返回
    4系 代表数据异常
    5系 代表服务器异常

错误码错误信息含义状态码
6000book_not_found图书不存在404
6002unauthorized_error没有修改权限403
6004review_content_short(should more than 150)书评内容过短(需多于150字)400
6006review_not_found书评不存在404
6007not_book_request不是豆瓣读书相关请求403
6008people_not_found用户不存在404
6009function_error服务器调用异常400
6010comment_too_long(should less than 350)短评字数过长(需少于350字)400
6011collection_exist(try PUT if you want to update)该图书已被收藏(如需更新请用PUT方法而不是POST)409
6012invalid_page_number(should be digit less than 1000000)非法页码(页码需要是小于1000000的数字)400
6013chapter_too_long(should less than 100)章节名过长(需小于100字)400

200(正常)
表示一切正常,返回的是正常请求结果。

302/307(临时重定向)
指出被请求的文档已被临时移动到别处,此文档的新的URL在Location响应头中给出。

304(未修改)
表示客户机缓存的版本是的,客户机应该继续使用它。

403(禁止)
服务器理解客户端请求,但拒绝处理它。通常由于服务器上文件或目录的权限设置所致。

404(找不到)
服务器上不存在客户机所请求的资源。

500(内部服务器错误)
服务器端的CGI、ASP、JSP等程序发生错误。

接口安全

  1. API的身份认证应该使用OAuth 2.0框架。
  2. 技术团队自己约定的规则
    - 增加两个参数 time, token
    - time为时间戳, 用于判断接口请求是否超时
    - token为时间戳加密后的字符串, 加密规则只有你们技术团队自己知道

参考资料

  • RESTful API 设计指南 - 阮一峰的网络日志
  • thinkphp5开发restful-api接口 - 网易云课堂
  • 豆瓣movie_v2

联系作者

  • CSDN博客:http://blog.csdn.net/u012104219
  • 知乎专栏:https://zhuanlan.zhihu.com/frankfeekr
  • Github:https://github.com/frank-lam
  • Email:frank_lin@whu.edu.cn

如果你觉得不错的话,不妨打赏一下,这样我就有更大的动力去完善它,优化它。

这篇关于以豆瓣网为例,讲解restful api设计规范的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1087521

相关文章

PHP应用中处理限流和API节流的最佳实践

《PHP应用中处理限流和API节流的最佳实践》限流和API节流对于确保Web应用程序的可靠性、安全性和可扩展性至关重要,本文将详细介绍PHP应用中处理限流和API节流的最佳实践,下面就来和小编一起学习... 目录限流的重要性在 php 中实施限流的最佳实践使用集中式存储进行状态管理(如 Redis)采用滑动

Unity新手入门学习殿堂级知识详细讲解(图文)

《Unity新手入门学习殿堂级知识详细讲解(图文)》Unity是一款跨平台游戏引擎,支持2D/3D及VR/AR开发,核心功能模块包括图形、音频、物理等,通过可视化编辑器与脚本扩展实现开发,项目结构含A... 目录入门概述什么是 UnityUnity引擎基础认知编辑器核心操作Unity 编辑器项目模式分类工程

Go语言使用net/http构建一个RESTful API的示例代码

《Go语言使用net/http构建一个RESTfulAPI的示例代码》Go的标准库net/http提供了构建Web服务所需的强大功能,虽然众多第三方框架(如Gin、Echo)已经封装了很多功能,但... 目录引言一、什么是 RESTful API?二、实战目标:用户信息管理 API三、代码实现1. 用户数据

Python用Flask封装API及调用详解

《Python用Flask封装API及调用详解》本文介绍Flask的优势(轻量、灵活、易扩展),对比GET/POST表单/JSON请求方式,涵盖错误处理、开发建议及生产环境部署注意事项... 目录一、Flask的优势一、基础设置二、GET请求方式服务端代码客户端调用三、POST表单方式服务端代码客户端调用四

MySQL连表查询之笛卡尔积查询的详细过程讲解

《MySQL连表查询之笛卡尔积查询的详细过程讲解》在使用MySQL或任何关系型数据库进行多表查询时,如果连接条件设置不当,就可能发生所谓的笛卡尔积现象,:本文主要介绍MySQL连表查询之笛卡尔积查... 目录一、笛卡尔积的数学本质二、mysql中的实现机制1. 显式语法2. 隐式语法3. 执行原理(以Nes

SpringBoot结合Knife4j进行API分组授权管理配置详解

《SpringBoot结合Knife4j进行API分组授权管理配置详解》在现代的微服务架构中,API文档和授权管理是不可或缺的一部分,本文将介绍如何在SpringBoot应用中集成Knife4j,并进... 目录环境准备配置 Swagger配置 Swagger OpenAPI自定义 Swagger UI 底

使用Python的requests库调用API接口的详细步骤

《使用Python的requests库调用API接口的详细步骤》使用Python的requests库调用API接口是开发中最常用的方式之一,它简化了HTTP请求的处理流程,以下是详细步骤和实战示例,涵... 目录一、准备工作:安装 requests 库二、基本调用流程(以 RESTful API 为例)1.

SpringBoot监控API请求耗时的6中解决解决方案

《SpringBoot监控API请求耗时的6中解决解决方案》本文介绍SpringBoot中记录API请求耗时的6种方案,包括手动埋点、AOP切面、拦截器、Filter、事件监听、Micrometer+... 目录1. 简介2.实战案例2.1 手动记录2.2 自定义AOP记录2.3 拦截器技术2.4 使用Fi

RabbitMQ消费端单线程与多线程案例讲解

《RabbitMQ消费端单线程与多线程案例讲解》文章解析RabbitMQ消费端单线程与多线程处理机制,说明concurrency控制消费者数量,max-concurrency控制最大线程数,prefe... 目录 一、基础概念详细解释:举个例子:✅ 单消费者 + 单线程消费❌ 单消费者 + 多线程消费❌ 多

从入门到进阶讲解Python自动化Playwright实战指南

《从入门到进阶讲解Python自动化Playwright实战指南》Playwright是针对Python语言的纯自动化工具,它可以通过单个API自动执行Chromium,Firefox和WebKit... 目录Playwright 简介核心优势安装步骤观点与案例结合Playwright 核心功能从零开始学习