本篇文章给大家分享的是有关SpringBoot中怎么使用swagger2构建Restful APIs，小编觉得挺实用的，因此分享给大家学习，希望大家阅读完这篇文章后可以有所收获，话不多说，跟着小编一起来看看吧。第一步，引入对应jar包：第二步，基本信息配置：基础的配置是对整个API文档的描述以及一些全局性的配置，对所有接口起作用。这里涉及到两个注解：@Configuration是表示这是一个配置类，是JDK自带的注解， 香港云主机前面的文章中也已做过说明。@EnableSwagger2的作用是启用Swagger2相关功能。在这个配置类里面我么实例化了一个Docket对象，这个对象主要包括三个方面的信息：整个API的描述信息，即ApiInfo对象包括的信息，这部分信息会在页面上展示。指定生成API文档的包名。指定生成API的路径。按路径生成API可支持四种模式，这个可以参考其源码：从源码可以看出，Swagger总共支持任何路径都生成、任何路径都不生成以及正则匹配和ant 模式匹配四种方式。大家可能比较熟悉的是前三种，最后一种ant匹配，如果不熟悉ant的话就直接忽略吧，前三种应该足够大家在日常工作中使用了。按照rest风格编写服务类第三步，启动并访问启动Spring boot，然后访问：http://127.0.0.1:8080/swagger-ui.html 即可看到如下结果：我们还可以点进去看一下每一个具体的接口，我们这里以“POST /rest/article”这个接口为例：可以看到，Swagger为每一个接口都生成了返回结果和请求参数的示例，并且能直接通过下面的”try it out”进行接口访问，方面大家对接口进行测试。整体上感觉Swagger还是很强大的，配置也比较简单。不过大家看到这里肯定会有点疑问：第一个问题：这个返回结果和请求参数都没有中文文字性的描述，这个可不可以配置？第二个问题：这个请求参应该是直接根据对象反射出来的结果，但是不是对象的每个属性都是必传的，另外参数的值也不一定满足我们的需求，这个能否配置？答案肯定是可以的，现在我们就来解决这两个问题，直接看配置的代码：列表页：可以看到，现在接口都位于Article这个tag下，并且接口后面也有了我们配置好的说明。我们再看下”POST /rest/article“这个接口的详情页：如果我们的请求参数是一个对象，那如何配置呢？这就涉及到另外两个注解：@ApiModel和@ApiModelProperty，我们还是先看代码，然后再解释，这样更容易理解：@ApiModel是对整个类的属性的配置：value：类的说明description：详细描述@ApiModelProperty是对具体每个字段的属性配置：name：字段名称value：字段的说明required：是否必须example：示例值hidden：是否显示完成上面的配置后，我们再来看效果：点击Try it out后，我们就可以看到返回的结果：操作还是很方便的，相比Junit和postman，通过Swagger来测试会更加便捷，当然，Swagger的测试并不能代替单元测试，不过，在联调的时候还是有非常大的作用的。以上就是SpringBoot中怎么使用swagger2构建Restful APIs，小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注开发云行业资讯频道。
今天小编给大家分享一下Win10如何设置软件开机自动启动的相关知识点，内容详细，逻辑清晰，相信大部分人都还太了解这方面的知识，所以分享这篇文章给大家参考一下，希望大家阅读完这篇文章后有所收获，下面我们一起来了解一下吧。设置软件开机自动启动步骤：把该应用程序的快…
免责声明：本站发布的图片视频文字，以转载和分享为主，文章观点不代表本站立场，本站不承担相关法律责任；如果涉及侵权请联系邮箱：360163164@qq.com举报，并提供相关证据，经查实将立刻删除涉嫌侵权内容。
微信扫一扫 
