SpringBoot配置Swagger实例（POST接收json参数）

工程目录结构：html

首先，引入jar包，只须要如下两个便可web

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.4.0</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.4.0</version>
</dependency>

一、Swagger配置类spring

package com.mark.swagger; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class Swagger2 { //swagger2的配置文件，这里能够配置swagger2的一些基本的内容，好比扫描的包等等
 @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.mark")) .paths(PathSelectors.any()) .build(); } //构建 api文档的详细信息函数,注意这里的注解引用的是哪一个
    private ApiInfo apiInfo() { return new ApiInfoBuilder() //页面标题
                .title("Spring Boot 测试使用 Swagger2 构建RESTful API") //建立人
                .contact(new Contact("WangXiaodong", "http://www.baidu.com", "")) //版本号
                .version("1.0") //描述
                .description("API 描述") .build(); } }

注意修改：basePackage("接口所在controller的包路径")json

二、实体类api

接口接收入参为json串，需由实体类转化为对应key-valueapp

package com.mark.swagger; public class User { private String name; public String getName() { return name; } public void setName(String name) { this.name = name; } @Override public String toString() { return "User [name=" + name + "]"; } }

三、接口所在Controlleride

package com.mark.swagger; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.RestController; import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; @RestController @RequestMapping("/hello") @Api(value = "/hello") public class SwagController { @ApiOperation(value = "查询用户", notes = "查询用户") @ApiImplicitParams({@ApiImplicitParam(name = "name", value = "姓名", required = true, dataType = "String"), }) @RequestMapping(value = "/getName",method=RequestMethod.POST) @ResponseBody public User getName(@RequestBody User name) { System.out.println(name.toString()); return name; } }

经过@RequestBody注解，将接收到的json参数，转化为实体类User对应的值函数

四、SpringBoot启动类测试

虽然你们都知道，仍是来一个吧ui

package com.mark; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import springfox.documentation.swagger2.annotations.EnableSwagger2;
 @SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }

测试

输入地址：localhost:8080/swagger-ui.html

以下所示：出现刚才写的接口

点击SHow/Hide

一、/hello/getName：路径

二、Model：入参json对应的model，就是上面的User

三、填写要传入的参数（json格式）

传入参数：

{ "name": "WangXiaodong" }

测试结果：