swagger常用注解

@Api（常用在Controller 类上，标记为 Swagger 文档资源）

package com.yk.controller.medicine;

import com.yk.pojo.Medicine;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Api(tags={"医疗组对应接口"})
public class MediController {

    @PostMapping("/getMedicine")
    public Medicine getMedicine(){
        return new Medicine();
    }
}

@ApiOperation（常用在Controller中的方法上表明方法的作用）

package com.yk.controller.medicine;

import com.yk.pojo.Medicine;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MediController {

    @ApiOperation("获取医疗信息")
    @PostMapping("/getMedicine")
    public Medicine getMedicine(){
        return new Medicine();
    }
}

ApiParam用于 Controller中的方法进行参数说明

package com.yk.controller.medicine;

import com.yk.pojo.Medicine;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MediController {

    @PostMapping("/getMedicine/{id}")
    public Medicine getMedicine(@ApiParam(value = "获取信息部门id",required = true) @PathVariable("id") String id){
        System.out.println(id);
        return new Medicine();
    }
}

@ApiModel和@ApiModelProperty（常用于实体类中说明，对应字段信息。当且仅当Controller类中有返回该实体类我们才能看到其注释信息）

package com.yk.pojo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import java.util.Date;

@ApiModel("医疗保障组数据记录")
public class Medicine {

    @ApiModelProperty("小组编号")
    private String id;
    @ApiModelProperty("记录时间")
    private Date date;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public Date getDate() {
        return date;
    }

    public void setDate(Date date) {
        this.date = date;
    }
}