web项目API接口设计与开发总结

      当前公司自主开发的一个AI图片识别项目，需要对外开放提供接口，领导二话没说把这个任务交给我来做，算是对我的一次考验。虽然以前自己没有设计过接口，但是调用过别人写的接口，如百度提供的接口，还有以前在项目中调用别人的接口等等。感觉调用别人的接口还挺方便的，自己来设计的时候，真不知道如何下手。然后去查看学习各种教程，开始进行接口的设计与开发工作。

 

设计原则

      鉴于目前的网络环境形式，设计的首要原则是安全第一原则，如果设计的接口不能保证其安全性，其他的活都相当于白干了。其次是简单原则，我认为调用接口的方式越简单越好，因为现在的人都很懒，这一点百度做得很好，调用他们的接口非常简单。如调用百度地图API，一个key就够了。目前只考虑到这两点，其他的还没有总结出来。

 

开发环境

       Node.js + WebStorm + MySQL//说明:公司选择JavaScript作为后台开发的主要语言，开发难度估计只有Java的一半，可是现在使用的公司却非常少，搞不懂为什么。据统计NPM上面包的下载量和MAVEN的包下载量不是一个量级的，使用NPM的人超多，比用MAVEN的人多多了。

 

整体设计

       这个接口的最终成型不是一下子全部就实现了，而是在工作中不断地改进，在每次改动中不断地变得越来越好，才算完成一个初步的版本。写代码就好比谈恋爱，两个人不可能一下子熟悉起来，立刻热恋，然后马上结婚，特例除外。在开发的过程中需要一直不停的更改，即使是上线了也有可能还需要修改，没有最终版本，因为需求的变动是不确