好看的Spring项目文档生成工具-MiApiDoc(2)

好看的Spring项目文档生成工具-MiApiDoc(1)已经介绍了如何在Spring项目中利用代码生成文档了，该篇文章将会介绍生成文档后的web网页的使用。

文件介绍

运行java代码后，会生成至少2个文件，一个是listConfig.json，该文件主要保存的是目录配置的信息，名称不能被更改，其他的是已.json结尾的文件，该文件为保存Api接口数据的，一般由用户定义名称。

快捷功能介绍

1.在用户未选中任何文字时，按下Ctrl+V，将会复制当前Api接口的Url。

2.点击参数名称即可复制该参数名。

3.点击Header Body可复制所有的参数名称。

功能介绍

1. 目录

目录主要用来区分不同功能接口的大分组，比如‘用户端接口、后台管理端接口’。

2.列表

列表主要用来显示分组、Api接口，当文档有新接口或者Api接口更新过的话，会有对应的提示。

3.右侧展示区介绍

展示区会将最近打开的Api接口保留，可快速切换。
展示区主要显示该Api接口的介绍、url、请求参数、备注、返回示例以及模拟请求。

4.模拟请求

点击模拟请求后，将会读取该Api接口的默认配置的header、body参数进行带参请求，用户可更改值后模拟请求，不需要其中某个参数时可将前面√去除。请求成功后，数据会在请求结果版面实现。

5.顶部栏介绍

顶部栏搜索框可输入Api的关键字以及Api的url进行搜索。
用户可选择切换不用用户身份进行请求，选择的用户如果配置了header参数，将会在模拟请求时一同跟随请求，如遇到相同字段则会根据用户配置来进行选择保留。
点击设置图标可打开设置页面，设置页面目前有请求设置、用户管理两个功能，这两个功能下面介绍。

6.请求设置

请求设置可设置全局请求默认header参数，设置后每一次模拟请求都会跟随请求，通过用户自行配置，如遇到相同字段则会根据用户配置来进行选择保留。如不需要其中某个字段，可将启用状态关闭或者删除该header字段即可。

7.用户管理

其实用户功能类似上面的请求设置，如果你选择了某个用户，这个用户下面的header参数也将会跟随模拟请求一并带参请求。
该功能主要目的是可以设置不同的用户身份，满足不同用户身份自由切换，而不用每次模拟请求都要手动设置用户身份的参数。
填完用户后可在顶部栏选择是否使用该用户，如不需要该用户，选择‘不选择用户’即可，或者直接删除该用户身份。

好了，目前上面就是MiApiDoc的web网页的使用介绍了，如果你有更好的想法，欢迎留言反馈，如果遇到bug请麻烦立即反馈哦，该项目会一直更新的！