栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

SpringBoot整合Swagger2基础

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

SpringBoot整合Swagger2基础

一、SpringBoot整合Swagger2
  1. 添加依赖

    
        io.springfox
        springfox-swagger2
        2.6.1
    
    
        io.springfox
        springfox-swagger-ui
        2.6.1
    
    
  2. 创建一个基本的spring,添加一个简单的业务

  3. 在启动类中添加@EnableSwagger2注解

  4. 在controller中添加api注解

    package com.tcc.controller;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import com.tcc.entity.User;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import io.swagger.annotations.ApiParam;
    
    @Api //修饰整个类,描述 Controller 的作用
    @RestController
    public class UserController {
    	
    	@ApiOperation("根据用户id获取用户") //描述一个类的一个方法,或者说一个接口
    	@RequestMapping("getUserById")
    	public Object getUserById(@ApiParam("用户id")int id) { //单个参数描述0
    		User user = new User(id, "张三");
    		return user;
    	}
    
    }
    
  5. 启动项目,访问: http://localhost:8080/swagger-ui.html

常用注解
  • @Api:修饰整个类,描述 Controller 的作用
  • @ApiOperation:描述一个类的一个方法,或者说一个接口
  • @ApiParam:单个参数描述
  • @ApiModel:用对象来接收参数
  • @ApiProperty:用对象接收参数时,描述对象的一个字段
  • @ApiResponse:HTTP 响应其中1个描述
  • @ApiResponses:HTTP 响应整体描述
  • @ApiIgnore:使用该注解忽略这个 API
  • @ApiImplicitParam:一个请求参数
  • @ApiError :发生错误返回的信息
  • @ApiImplicitParams:多个请求参数
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/947010.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号