注：执行过程中有可能因为网络傳输问题报错只需等待重连即可，报错信息如下：

2.8 使用–list来查看具体参数：

目前来说在 Java 领域使用 Springboot 构建微服務是比较流行的，在构建微服务时我们大多数会选择暴漏一个 REST API 以供调用。又或者公司采用前后端分离的开发模式让前端和后端的工作甴完全不同的工程师进行开发完成。不管是微服务还是这种前后端分离开发维持一份完整的及时更新的 REST API 文档，会极大的提高我们的工作效率而传统的文档更新方式（如手动编写），很难保证文档的及时性经常会年久失修，失去应有的意义因此选择一种新的 API 文档维护方式很有必要，这也是这篇文章要介绍的内容

对于传参的设计也有规范，可以像下面这样：

最后为了让代码变得更加符合规范和好用，使用一个统一的类进行接口响应

直接启动 Springboog 项目，可以看到控制台输出扫描到的各个接口的访问路径其中就有 /2/api-docs。

这个也就是生成的 OpenAPI 规范的描述 JSON 访问路径访问可以看到。

因为上面我们在引入依赖时也引入了 springfox-swagger-ui 包，所以还可以访问 API 的页面文档访问路径是 /swagger-ui.html，访问看到的效果可以看下图

也可以看到用户查询的两个方法会归到了一起，原因就是这两个方法的注解上使用相同的 tag 属性

springfox-swagger-ui 不仅是生成了 API 文档，还提供了调用测试功能下面是在页面上测试获取单个用户信息的过程。

下面是测试时的响应截图

如果你在程序运行中经常发现像下面这样嘚报错。