- iOS/Objective-C 元类和类别
- objective-c - -1001 错误,当 NSURLSession 通过 httpproxy 和/etc/hosts
- java - 使用网络类获取 url 地址
- ios - 推送通知中不播放声音
我的任务是详细介绍一个简单的api,我做了一点调查,怀疑我所知道的关于互联网的一切都是错误的。
我在谷歌上搜索的时间比我想承认的要长得多,阅读了很多文章、堆积如山的问题和网站,这些似乎都强烈反对。我承认每个开发人员做事情的方式都不同,但仍然怀疑某个地方有一个官方标准,或者至少有一个通用的最佳实践(尽管不可否认,并不是每个人都遵循任何最佳实践)。
这个api将使用json。我无法改变。
我的本地同行告诉我的(很可能是不正确的):
http是一个复杂的、过时的野兽,我们应该尽可能少地处理它。它只是一个来回移动json块的工具,在那里会发生魔力。所有数据和元数据都应该在json中,您可以完全按照自己的喜好设置它。
对所有内容使用200状态代码,即使用户的输入有应用程序级别的错误或问题。其他错误代码意味着http操作出了问题——一个灾难性的意外服务器错误,使用了错误的url,诸如此类。
“信封”来自服务器的消息的json数据;具有元数据的json属性,并在一致属性(如“data”)中包含实际的json对象/数组
https是“不错的选择”,但对小项目来说并不重要
对所有内容使用PUT请求
登录以从服务器获取随机的强字符作为访问令牌。服务器存储有关令牌何时过期、用于哪个帐户以及使用它的IP地址的信息。将该访问令牌传递给服务器以进行其他每次调用;客户端不存储密码。
url通常是动词,如/register或/checkout或/changepassword。所有其他需要的数据都在json中。每个操作都有自己的url
根据我的阅读,我认为可能是对的,但不确定
http是神圣的数据结构。头信息和服务器返回代码可以包含任何可能的元数据,并且确实是为此目的而设计的。内容只需要包含应用程序所作用的实际json对象。在json主体中不放任何可能是http元数据一部分的内容。
总是使用https
对于任何可能的错误(表单字段未验证、用户的会话已过期、他们的游戏角色已死亡),发送一个http状态代码。试着根据w3c的描述选择最接近的内容,但真正重要的是在系统中始终如一地使用它。代码应该足以告诉客户端应用程序要做什么(显示用户验证错误并使其修复表单输入,使用户再次登录,将用户带回主屏幕)。如果出现错误,正文将包含有关错误的额外详细信息(如果需要)。
客户端应用程序应在http头中随每个请求传递登录信息。这意味着它需要使用basic auth,这意味着它需要记住用户的密码。
json数据不应该放在“信封”中。没有标准格式,因为内容直接表示给定操作所需的对象,如url、get/post/put/delete组合所示
url往往是名词,比如/user或/shoppingcart。url的子目录引用正在操作的对象id:/user/johndoe或/shoppingcart/12359。url可用于get(retrieve data)post(update data)put(create new data)delete(remove data)的不同操作。
我甚至不确定这两种方法是否完全正确——你能告诉我什么是正式的,或者是最推荐的构造这样一个api的方法的规则吗?
最佳答案
你应该阅读田野调查论文的相关部分,它定义了什么是rest:http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm
markus的另一篇论文:http://www.markus-lanthaler.com/research/third-generation-web-apis-bridging-the-gap-between-rest-and-linked-data.pdf他开始了创建标准rest实现的工作:http://www.hydra-cg.com/rdf rest vocab和http://json-ld.org/rdf json格式。目前我们还没有一个标准的解决方案来描述任何rest服务的统一接口。这就像我们没有一个html标准。这就是为什么我们不能只编写特定于应用程序的客户端的rest浏览器。
(hydra还没有准备好生产,我想they还需要2-3年的时间来标准化它,并开始构建hydra特定的工具。在此之前,我们不能真正讨论真正的rest,因为大多数api定义了一种特定于实现的格式,或者使用了一种或多或少通用的非标准格式,比如hal)。
关于json - RESTful HTTP API标准? ,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/23547082/
我最近在读 CSAPP。在 10.9 节中,它说标准 I/O 不应该与 socket 一起使用,原因如下: (1) The restrictions of standard I/O Restricti
似乎是一个足够标准的问题,可以保证解决方案中的标准设计: 假设我想在文件中写入 x+2(或更少)个字符串。 x 字符串构成一个部分的内容,这两个字符串构成该部分的页眉和页脚。要注意的是,如果内容中没有
代码版本管理 在项目中,代码的版本管理非常重要。每个需求版本的代码开发在版本控制里都应该经过以下几个步骤。 在master分支中拉取该需求版本的两个分支,一个feature分支,
我有以下sql查询,我需要获取相应的hibernate条件查询 SELECT COUNT(DISTINCT employee_id) FROM erp_hr_payment WHERE payment
所以我正在编写一些代码,并且最近遇到了实现一些 mixin 的需要。我的问题是,设计混音的正确方法是什么?我将使用下面的示例代码来说明我的确切查询。 class Projectile(Movable,
我的环境变量包含如下双引号: $echo $CONNECT_SASL_JAAS_CONFIG org.apache.kafka.common.security.plain.PlainLoginModu
示例: /** * This function will determine whether or not one string starts with another string. * @pa
有没有办法在 Grails 中做一个不区分大小写的 in 子句? 我有这个: "in"("name", filters.tags) 我希望它忽略大小写。我想我可以做一个 sqlRestriction
我搜索了很长时间,以查找将哪些boost库添加到std库中,但是我只找到了一个新库的完整列表(如此处:http://open-std.org/jtc1/sc22/wg21/docs/library_t
我已经通过使用这个肮脏的黑客解决了我的问题: ' Filter managerial functions ActiveSheet.Range("$A$1:$BW$2211").Auto
因此,我很难理解我需要遵循的标准,以便我的 Java 程序能够嵌入 HTML。我是否只需将我的主类扩展到 Applet 类,或者我还需要做更多的事情吗?另外,在我见过的每个 Applet 示例中,它都
我对在 Hibernate 中使用限制有疑问。 我必须创建条件,设置一些限制,然后选择日期字段最大值的记录: Criteria query = session.createCriteria(Stora
我有标准: ICriteria criteria = Session.CreateCriteria() .SetFetchMode("Entity1", FetchMo
我很难编写条件来选择所有子集合或孙集合为空的实体。我可以将这些作为单独的条件来执行,但我无法将其组合成一个条件。 类结构: public class Component { p
@Entity class A { @ManyToMany private List list; ... } @Entity class B { ... } 我想使用条件(不是 sql 查询)从 A
我的数据库中有以下表结构: Table A: Table B: Table C: _______________
请帮助我: 我有下一张 table : 单位 ID 姓名 用户 ID 姓名 利率 单位 ID 用户 ID 我不明白如何从 SQL 创建正确的条件结构: 代码: SELECT * FROM Unit W
我正在构建一个包含项目的网站,每个项目都有一个页面,例如: website.com/book/123 website.com/film/456 website.com/game/789 每个项目都可以
我需要使用两个属性的组合来过滤结果列表。一个简单的 SQL 语句如下所示: SELECT TOP 10 * FROM Person WHERE FirstName + ' ' + LastName L
我有一个“ super 实体”SuperEntity 和三个扩展父类(super class)的实体 ChildEntity1、...、ChildEntity3。 搜索数据库中的所有实体很容易,即我们
我是一名优秀的程序员,十分优秀!