spring boot+iview 前后端分离架构之接口文档的编写（八）

妖狐艹你老母 2022-01-30 00:19 226阅读 0赞

### spring boot 与 iview 前后端分离架构之接口文档的编写（八） ###

*  公众号
 *  markDownPad2安装
 *  markDown的使用
 *  编写接口文档

# 公众号 #

![在这里插入图片描述][20191218155125364.jpg]  
大家可以直接微信扫描上面的二维码关注我的公众号，然后回复【bg08】 里面就会给到源代码的下载地址同时会附上相应的视频教程，并定期在我的公众号上给大家推送相应的技术文章，欢迎大家关注我的公众号。

# markDownPad2安装 #

首先大家可以直接去以下的百度网盘的地址直接下载markDownPad2的安装包，然后安装这款mark down软件。  
链接: https://pan.baidu.com/s/1FgD6KbiveHCYTeXdLC1n-A 提取码: bksu

# markDown的使用 #

mark down的语法大家可以直接去w3c上去看，这是一个很好的编写接口文档的软件，如果你还是喜欢用doc去编写接口文档那就请跳过本章节，不过相信我用了这个以后你再也不想用doc去编写接口文档了，地址：[https://www.w3cschool.cn/markdownyfsm/markdownyfsm-odm6256r.html][https_www.w3cschool.cn_markdownyfsm_markdownyfsm-odm6256r.html]

# 编写接口文档 #

在前面几章的时候我们已经完成了我们的数据库的设计、以及代码的生成，好像感觉我们现在就可以开始编写我们的代码了，但是到这里实际上大家发现了没有，我们缺少一个产品的原型，没有产品原型如何编写接口文档呢。  
因此假定我们这边已经有了产品设计好的原型了，那么我们就按着原型来开始编写我们的接口文档，根据我们事先设计好的数据我们就可以开始编写我们的接口文档。  
1、用户管理接口文档  
2、菜单管理接口文档  
3、角色管理接口文档  
4、日志管理接口文档  
5、组织架构接口文档  
6、数据字典接口文档  
以下就是我们编写的时候的实时效果图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpbnpoZWZlbmc4OQ_size_16_color_FFFFFF_t_70]  
通过编写接口文档的过程我们对整个系统的业务逻辑有了一次深刻的认识，同时也为接下来前端的开发人员提供了后续的文档的支持，当一个项目过于久远以后，通过接口文档我们可以快速的回顾起我们当时的设计。  
上一篇文章地址：[spring boot 与 iview 前后端分离架构之前端指定环境的实现（七）][spring boot _ iview]  
下一篇文章地址：[spring boot+iview 前后端分离架构之前端mock的实现（九）][spring boot_iview _mock]

[20191218155125364.jpg]: /images/20220130/5fcbb607c30d458ea1a63b12e07b8fa2.png
[https_www.w3cschool.cn_markdownyfsm_markdownyfsm-odm6256r.html]: https://www.w3cschool.cn/markdownyfsm/markdownyfsm-odm6256r.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpbnpoZWZlbmc4OQ_size_16_color_FFFFFF_t_70]: /images/20220130/0548bcd340f540559d2830e276535ded.png
[spring boot _ iview]: https://blog.csdn.net/linzhefeng89/article/details/90287273
[spring boot_iview _mock]: https://blog.csdn.net/linzhefeng89/article/details/90412922