自学内容网 自学内容网

springboot3.3.4集成接口文档Swagger、Knife4j

1、springboot3.3.4集成Swagger

1、导包
<!--springboot3.3.4集成Swagger-->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.0.2</version>
</dependency>
2、不需要额外的配置类、访问 http://localhost:8080/swagger-ui.html
3、在controller类、方法、参数上使用相关注解
  • @Tag:用于描述控制器或方法的标签。
  • @Parameter:用于描述方法参数。
  • @ApiResponse:用于描述方法的响应。
  • @Schema:用于描述模型类的字段

2、springboot3.3.4集成Swagger

1、导包
<!--springboot3.3.4集成Knife4j,knife4j-spring-boot-starter版本须在4.0.0以上,当前方式未测试,包不太好找-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>
2、访问地址 http://localhost:8080/doc.html
3、在controller类、方法、参数上使用相关注解
  • @Api:用于描述控制器。
  • @ApiOperation:用于描述方法。
  • @ApiParam:用于描述方法参数。
  • @ApiModel:用于描述模型类。
  • @ApiModelProperty:用于描述模型类的字段。

原文地址:https://blog.csdn.net/weixin_45476535/article/details/143527817

免责声明:本站文章内容转载自网络资源,如本站内容侵犯了原著者的合法权益,可联系本站删除。更多内容请关注自学内容网(zxcms.com)!