swagger如何访问（swagger查看）



Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 Restful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

Swagger是最流行的API开发工具，它遵循OpenAPI Specification（OpenAPI规范，简称OAS），有了它，可以不用PostMan测试接口了

Swagger可以贯穿于整个API生态，如API的设计、编写API文档、测试和部署。本文查看Swagger如何用于接口文档在线生成以及功能测试。

http://localhost:8080/swagger-ui.html

选择待测试接口

点击创建

Try it out

输入相关的值，点击创建

创建

查看执行结果

结果

SpringBoot_Swagger

官方文档参考 https://editor.swagger.io/

常用的注解

• @Api：用在类上，说明该类的作用
• @ApiOperation：给API增加方法说明
• @ApiImplicitParams : 用在方法上包含多个参数说明
• @ApiImplicitParam：用在方法上包含一个参数说明
• @ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）
• @ApiModelProperty：描述一个model的属性
  参数说明：
  
  

paramType类型

• @ApiResponses：用于表示一组响应。
• @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息。

版权声明：

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符，请将相关资料发送至xkadmin@xkablog.com进行投诉反馈，一经查实，立即处理！

转载请注明出处，原文链接：https://www.xkablog.com/rfx/30993.html