用GET和POST举例,其他同理
@Tag(name = "组一", description = "第一组接口说明")
@Path("/hello")
public class Controller1 {
@Operation(summary = "get接口的简述", description = "详细说明")
@Parameters({
@Parameter(name = "a", description = "a的说明", in = ParameterIn.DEFAULT),
@Parameter(name = "b", description = "b的说明", in = ParameterIn.PATH),
@Parameter(name = "c", description = "c的说明", in = ParameterIn.HEADER),
})
@Path("/testget/{b}")
@GET
@Produces(MediaType.TEXT_PLAIN)
public String testGet(@QueryParam("a") String a,
@PathParam("b") String b,
@HeaderParam("c") String c) {
System.out.println(a);
System.out.println(b);
System.out.println(c);
return "get";
}
@Operation(summary = "post接口的简述", description = "详细说明")
@RequestBody(description = "Post参数说明",
required = true,
content = @Content(mediaType = MediaType.APPLICATION_JSON))
@Path("/testpost")
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public String testPost(PostBody body) throws JsonProcessingException {
System.out.println(body.a);
System.out.println(body.b);
return "post";
}
}
public class PostBody {
@Schema(description = "a的说明")
public Integer a;
@Schema(description = "b的说明")
public String b;
}
- 浏览器打开
http://localhost:8080/swagger-ui
就可以查看接口说明和测试了