开发工具Tools·Swagger
Swagger
Swagger 提供了一套通过代码和注解自动生成文档的方法。
添加依赖
配置参数
配置类
@Profile({"dev", "test"})
只在开发和测试环境启用 swagger。
使用
注解名称 | 使用说明 |
---|---|
@Api | 描述一个 API 类 |
@ApiImplicitParam | 描述一个请求参数 |
@ApiImplicitParams | 描述一组请求参数 |
@ApiModel | 描述一个返回的对象 |
@ApiModelProperty | 描述一个返回的对象参数 |
@ApiOperation | 描述一个 API 方法 |
@ApiParam | 描述一个方法的参数 |
@ApiResponse | 描述一个请求响应 |
@ApiResponses | 描述一组请求响应 |
@ApiIgnore | 表示忽略 |
ApiImplicitParam
与 ApiParam
的区别:
- 对 Servlets 或者非 JAX-RS 的环境,只能使用
ApiImplicitParam
。 - 在使用上,
ApiImplicitParam
比ApiParam
具有更少的代码侵入性,只要写在方法上就可以了,但是需要提供具体的属性才能配合 swagger ui 解析使用。 ApiParam
只需要较少的属性,与 swagger ui 配合更好。
启动项目访问路径查看文档:http://192.168.51.242:8080/swagger-ui.html#/
。
Cannot resolve configuration property
解决步骤:
- 添加依赖
spring-boot-configuration-processor
依赖 - 添加
src/main/resources/META-INF/spring-configuration-metadata.json
文件
首先添加 spring-boot-configuration-processor
依赖:
之后添加 src/main/resources/META-INF/spring-configuration-metadata.json
文件:
本站所提供的部分资源来自于网络,版权争议与本站无关,版权归原创者所有!仅限用于学习和研究目的,不得将上述内容资源用于商业或者非法用途,否则,一切后果请用户自负。您必须在下载后的24个小时之内,从您的电脑中彻底删除上述内容资源。如果上述内容资对您的版权或者利益造成损害,请提供相应的资质证明,我们将于3个工作日内予以删除。本站不保证所提供下载的资源的准确性、安全性和完整性,源码仅供下载学习之用!如用于商业或者非法用途,与本站无关,一切后果请用户自负!本站也不承担用户因使用这些下载资源对自己和他人造成任何形式的损失或伤害。如有侵权、不妥之处,请联系站长以便删除!
金点网络-全网资源,一网打尽 » 开发工具Tools·Swagger
金点网络-全网资源,一网打尽 » 开发工具Tools·Swagger
常见问题FAQ
- 免费下载或者VIP会员专享资源能否直接商用?
- 本站所有资源版权均属于原作者所有,这里所提供资源均只能用于参考学习用,请勿直接商用。若由于商用引起版权纠纷,一切责任均由使用者承担。
- 是否提供免费更新服务?
- 持续更新,永久免费
- 是否经过安全检测?
- 安全无毒,放心食用