-
问题一:组织url
-
通过url中的开头来解决,/static/表示静态资源,/api/表示rest api
-
通过子域名区分
-
-
问题二:统一输出
-
区分REST API 和 非REST API
-
绑定一个rest()方法,设置得有ctx.response.type = "application/json" ctx.response.body = data
-
该middleware不仅仅能实现REST API的需求,还得满足可能出现的其他需求
-
-
问题三:处理错误
-
REST API 请求出错时,如何返回错误
-
客户端如何判断时成功还是错误
-
REST API发生错误不外乎两种情况,
第一类,403,404,500一类的http请求错误,客户端可以识别,但是无法操控错误代码
第二类,业务逻辑错误,即email格式错误,密码错误一类的客户端可识别,可修正的错误。这类错误完全可以以 json 的格式返回给客户端,并且客户可根据提示修正错误。
HTTP的返回码选择:
第一种选择,使用200,识别出第一类错误后,如果遇到200响应,则根据json判断是否出错。着对于动态语言很方便。
第二种选择,成功使用200,错误使用400,这时即使客户端时静态语言也能根据http返回码进行判断出错。
注意:如果选择了第二种方式就不能再混合其他的错误码,401,403等。因为HTTP协议定义的错误码偏向底层,而“REST API”属于“高级协议”不应该复用底层的错误码。
-
问题四:定义错误码
-
建议使用字符串定义,方便理解错误码的意思。
-
-
问题五:返回错误
-
注意,不是第二点统一输出
-
这里是返回错误。推荐使用异步函数调用throw抛出错误
-