https://blog.mwaysolutions.com/2014/06/05/10-best-practices-for-better-restful-api/ 翻译:意译为主,不逐字翻译 The concept of REST is to separate the API structure into logical resources. We should use the HTTP methods GET, DELETE, POST and PUT to operate with the resources. REST的概念,...
为了防止API使用者为了获取更新后的资源而再次调用该API,应当使API把更新(或创建)后的资源作为response的一部分来返回。 以一个产生创建活动的 POST 操作为例, 使用一个HTTP 201 状态代码然后包含一个Location header来指向新生资源的URL。 你是否应该HATEOAS? (译注:Hypermedia as the Engine of Application State (...
如果API使用者确实无法访问返回头,或者API需要支持交叉域请求(通过jsonp)。 jsonp请求在请求的url中包含了一个callback函数参数。如果给出了这个参数,那么API应该返回200,并且把真正的状态码放到返回值里面(包装在信封里),例如: JavaScript callback_function({ status_code:200, next_page:"https://..", respon...
为了防止API使用者为了获取更新后的资源而再次调用该API,应当使API把更新(或创建)后的资源作为response的一部分来返回。 以一个产生创建活动的 POST 操作为例, 使用一个 HTTP 201 状态代码 然后包含一个 Location header 来指向新生资源的URL。 你是否应该HATEOAS? (译注:Hypermed...
This kind of design is a real no-nobecauseit breaks the trust between the API and their users. You come to fear that the API could be lying to you. All of this isextremelyun-RESTful. What should you do instead? Make use of the status code and only use the response body to provide...
不要使用下划线(year_of_birth)或大驼峰命名法(YearOfBirth)。通常,RESTful Web服务将被Java编写的客户端使用。客户端会将JSON响应转换为Java对象(通过调用var person = JSON.parse(response)),然后调用其属性。因此,最好遵循Java代码通用规范。 对比:
通常我们为Web API使用RESTful设计,REST概念分离了API结构和逻辑资源,通过Http方法GET, DELETE, POST 和 PUT来操作资源。 下面是进行RESTful Web API十个最佳实践,能为你提供一个良好的API设计风格。 1.使用名词而不是动词 不要使用: /getAllCars /createNewCar ...
http://stackoverflow.com/questions/942951/rest-api-error-return-good-practices http://goldbergyoni.com/checklist-best-practices-of-node-js-error-handling/ http://blogs.mulesoft.com/dev/api-dev/api-best-practices-response-handling/ https://developers.facebook.com/docs/graph-api/using-graph-api/...
不要使用下划线(year_of_birth)或大驼峰命名法(YearOfBirth)。通常,RESTful Web服务将被JavaScript编写的客户端使用。客户端会将JSON响应转换为JavaScript对象(通过调用var person = JSON.parse(response)),然后调用其属性。因此,最好遵循JavaScript代码通用规范。
Provide feedback and support mechanism for API users. Would it be good to have API design practices so you can jump-start the API design? No, not yet. We need to get to know about a few core API design principles, which we will review next. ...