接口文档编写

 

 这个星期在编写接口的过程中遇到了很多问题，也应该总结总结了

1.文档的编写：对需要调用接口的人来说,最重要有3个部分,接口地址,传入参数,返回结果。调用者不会关心内部实现细节，同时后台操作人员也要能够通过阅读文档，获取需要的信息

    所以要把前台需要的3个关键部分放在一起，修改的表以及字段放在最后

 

2.一个需求，接口返回给前台，只有成功和失败2种结果，那么什么情况是成功，什么情况是失败，这个要提前沟通好，然后再写代码

 

3.接口对后台来说同样重要，对后台数据库的一些操作，要明确需要修改什么字段

 

4.一些方法可以进行封装，增强可读性