美文网首页
API 接口书写心得

API 接口书写心得

作者: 刘月玮 | 来源:发表于2017-07-07 18:19 被阅读61次

背景:

定义 CMTeam 的生成测试、生成计划、题目优化(timer 触发)的接口,接口规则同产品开发组(文档可找我来取),建议提前阅读如下内容:

阅读以下链接:
https://hackernoon.com/restful-api-designing-guidelines-the-best-practices-60e1d954e7c9

https://www.snyxius.com/blog/21-best-practices-designing-launching-restful-api/#.WUJcEROGOHo

编辑工具

推荐使用在线编辑:
http://editor.swagger.io/

概念

  1. API 要基于前端页面请求,而非已有的函数模块。凡是产品开发组需要调用的函数,都需要写成 url 的形式。
  2. 资源的概念。Paper,Plan,Institution,Class,User

书写规范

见标准文档。

报错指南

见标准文档。

相关文章

网友评论

      本文标题:API 接口书写心得

      本文链接:https://www.haomeiwen.com/subject/iykrhxtx.html