写给开发小白的---如何写前后端分离的API设计文档

    最近在进行一个公司内部可视化执行工具的开发，在过程中遇到的一些问题就总结一下了。

    我们知道，现在我们的开发基本都是前后端分离的，这样就可以方便后端开发人员全身心投入到后端逻辑实现的工作中，前端工程师全身心的为用户提供更好的使用体验上，前后端分离显得尤为重要，因此这里需要通过一个API设计文档，来为前后端开发人员设定约束，约定好了,可以进行同步开发.

    因为当时开发的项目是一个python web项目，做了一个批量进行任务下载和上传的可视化工具，功能也比较简单，这里就以此为例，进行具体说明：

    我们知道后端开发人员的任务，主要负责业务逻辑处理，前端开发人员来负责信息展示，前后端连接的纽带就是url，后端通过url给前端传递数据，前端通过url活动数据对象，进行显示。

    因此API设计文档，重要的就是这个url的限定，还有数据对象的约定。

    例如我们的界面首页，假设链接为：http://11.12.157.33:80/index.html?user=user

     这里的第一个user是表示对象的名称，第二个user表示的是对应的用户信息，我们一半传递的对象为json类型 或者list类型的对象居多

    这里user就是json类型，具体如下：user对应的json类型如下user={'username'：'xxxx','pass':'ccc'} （其实user是一个字典类型）

    这里面我们前后端的工作人员，只需要把链接和传递的数据类型相互沟通好，那么最后API文档就是一些对应的这些内容：

    例如：

    1.首页：http://11.12.157.33:80/index.html?user=user

     user对象结构： user={'username'：'xxxx','pass':'ccc'}     用户未登录状态 user=null

    2.类别列表： http://11.12.157.33:80/show.html?infolist=info

     info对象结构： info=['aaa','bbb','ccc']   (list类型)

    `````````

    

    这样就构成了前后端分离的API设计文档，怎么样，你明白了吗？

    由于能力有限，如有说的不准确的地方，欢迎有经验的大牛指正～

 

===========

我是晶心Monica，一个努力进阶的程序媛，欢迎我们一起交流学习～

也欢迎多多关注哈～

公众号：学习生活微交流 （公众号：xxshwjl） 我会在公众号分享一些关于我的学习生活心得，期待和努力向上的你一起交流～

===========