码迷,mamicode.com
首页 > Windows程序 > 详细

写RestApi需要注意些什么?

时间:2018-05-07 19:28:32      阅读:216      评论:0      收藏:0      [点我收藏+]

标签:调用   学习   增删改   不同   控制   信息   技巧   dev   模仿   

  • PS1="\n[\e[32;1m]([\e[37;1m]\u[\e[32;1m])-([\e[37;1m]jobs:\j[\e[32;1m])-([\e[37;1m]\w[\e[32;1m])\n([[\e[37;1m]! ![\e[32;1m])-> [\e[0m]"
  • 业务是model层来负责的,控制层只负责调用 

  • 使用XMind来画思维导图,自问自答的方式,在实践中不断加深对软件的熟悉度以及使用技巧

  • 数据库表设计时建议使用软的外键约束,软删除;同时,数据库表的设计时很难一开始就考虑完整,可能开发过程中也会进行一些字段的change

  • 在Postman中访问url链接时直接通过添加?DEBUGSESSIONSTAER的后缀,也可以拉起phpstrom的断点调试

  • 怎么考虑开始写一个接口?

  • 从实际应用的某个操作,比如登录,跳转等,可以对应到某段业务逻辑,思考需要哪些参数,写对应的方法,刚开始时可以考虑在Controller中写用来测试,之后要转移到Model中去

  • 都需要考虑到什么?

  • 不同的版本v1, v2; 方法接受参数的验证(验证器的思想,可能会提取一些公用的方法到基类BaseValidate中); 整个api调用过程中可能会发生的异常

  • 代码封装性越好,越抽象,代码复用性越好

  • @ RESTFul API

  • 基于资源,增删改查都是基于对资源状态的改变;使用HTTP动词来操作资源(/getmoive/:mid GET:/moive/:mid 建议后者)

  • @ HTTP动词 POST:创建 PUT:更新 GET:查询 DELETE:删除

  • 状态码: 404(Not Found), 400(Parameters Error), 200, 201, 202, 401(Unauthorized), 403, 500

  • 错误码: 自定义的错误ID号

  • 统一描述错误:错误码,错误信息,发生当前错误信息的URL

  • 使用Token令牌来授权和验证身份

  • 版本控制

  • 测试与生产环境分开:api.xxx.com/dev.api.xxx.com

  • URL语义要明确,最好可以“望文知意"

  • 最好是有一份比较标准的文档

  • 最好的学习方法:模仿 豆瓣开放api; github开发者api

  • API是通过Token,令牌来验证和授权的,要考虑三点:Token是不是有效的(数据库中有对应的行)?Token的有效期;Token对应的权限

写RestApi需要注意些什么?

标签:调用   学习   增删改   不同   控制   信息   技巧   dev   模仿   

原文地址:https://www.cnblogs.com/wjf0/p/9003876.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!