{"id":18333,"date":"2020-02-05T17:50:15","date_gmt":"2020-02-05T09:50:15","guid":{"rendered":"http:\/\/4563.org\/?p=18333"},"modified":"2020-02-05T17:50:15","modified_gmt":"2020-02-05T09:50:15","slug":"swagger%e8%af%a6%e8%a7%a3%ef%bc%88springbootswagger%e9%9b%86%e6%88%90%ef%bc%89-vps%e8%b5%84%e8%ae%af","status":"publish","type":"post","link":"http:\/\/4563.org\/?p=18333","title":{"rendered":"Swagger\u8be6\u89e3\uff08SpringBoot+Swagger\u96c6\u6210\uff09 – VPS\u8d44\u8baf"},"content":{"rendered":"
\n

Swagger-API\u6587\u6863\u63a5\u53e3\u5f15\u64ce<\/h2>\n

Swagger\u662f\u4ec0\u4e48<\/h3>\n

Swagger\u662f\u4e00\u4e2a\u89c4\u8303\u548c\u5b8c\u6574\u7684\u6846\u67b6\uff0c\u7528\u4e8e\u751f\u6210\u3001\u63cf\u8ff0\u3001\u8c03\u7528\u548c\u53ef\u89c6\u5316 RESTful \u98ce\u683c\u7684 Web \u670d\u52a1\u3002\u603b\u4f53\u76ee\u6807\u662f\u4f7f\u5ba2\u6237\u7aef\u548c\u6587\u4ef6\u7cfb\u7edf\u4f5c\u4e3a\u670d\u52a1\u5668\u4ee5\u540c\u6837\u7684\u901f\u5ea6\u6765\u66f4\u65b0\u3002\u6587\u4ef6\u7684\u65b9\u6cd5\uff0c\u53c2\u6570\u548c\u6a21\u578b\u7d27\u5bc6\u96c6\u6210\u5230\u670d\u52a1\u5668\u7aef\u7684\u4ee3\u7801\uff0c\u5141\u8bb8API\u6765\u59cb\u7ec8\u4fdd\u6301\u540c\u6b65\u3002<\/p>\n

\u5728\u9879\u76ee\u5f00\u53d1\u4e2d\uff0c\u6839\u636e\u4e1a\u52a1\u4ee3\u7801\u81ea\u52a8\u751f\u6210API\u6587\u6863\uff0c\u7ed9\u524d\u7aef\u63d0\u4f9b\u5728\u7ebf\u6d4b\u8bd5\uff0c\u81ea\u52a8\u663e\u793aJSON\u683c\u5f0f\uff0c\u65b9\u4fbf\u4e86\u540e\u7aef\u4e0e\u524d\u7aef\u7684\u6c9f\u901a\u4e0e\u8c03\u8bd5\u6210\u672c\u3002<\/p>\n

Swagger\u6709\u4e00\u4e2a\u7f3a\u70b9\u5c31\u662f\u4fb5\u5165\u6027\u6a21\u5f0f\uff0c\u5fc5\u987b\u914d\u7f6e\u5728\u5177\u4f53\u7684\u4ee3\u7801\u91cc\u3002<\/p>\n

Swagger\u4f7f\u7528\uff08SpringBoot+Swagger\u96c6\u6210\uff09<\/h3>\n

\u65b0\u5efaMaven\u9879\u76ee<\/p>\n

\u7b2c\u4e00\u79cd\u65b9\u5f0f\uff1a\u4f7f\u7528\u7b2c\u4e09\u65b9\u4f9d\u8d56<\/h3>\n

1.\u5728pom.xml\u6587\u4ef6\u4e2d\u6dfb\u52a0\u7b2c\u4e09\u65b9swagger\u4f9d\u8d56<\/p>\n

<dependency><\/p>\n

<groupId>com.spring4all<\/groupId> <artifactId>swagger-spring-boot-starter<\/artifactId> <version>1.7.0.RELEASE<\/version><\/code><\/pre>\n
<\/dependency>
2\u3001\u5728Spring Boot\u9879\u76ee\u7684\u542f\u52a8\u7c7b\u4e0a\u6dfb\u52a0@EnableSwagger2\uff0c\u542f\u52a8Swagger\u00a0
3\u3001https:\/\/github.com\/SpringForAll\/spring-boot-starter-swagger<\/a>\uff0cGitHub\u4e0a\u8fd9\u4e2aswagger\u4f9d\u8d56\u5b9e\u73b0\u7684\u9879\u76ee\uff0c\u91cc\u9762\u6709\u8be6\u7ec6\u7684\u8bb2\u89e3\u3002<\/p>\n
\u7b2c\u4e8c\u79cd\u65b9\u5f0f\uff1a\u4f7f\u7528\u5b98\u65b9\u4f9d\u8d56<\/h3>\n
1.\u5728pom.xml\u6587\u4ef6\u4e2d\u6dfb\u52a0swagger\u76f8\u5173\u4f9d\u8d56<\/p>\n
<dependency><\/p>\n
    <groupId>io.springfox<\/groupId>     <artifactId>springfox-swagger2<\/artifactId>     <version>2.2.2<\/version><\/code><\/pre>\n
<\/dependency>
<dependency><\/p>\n
    <groupId>io.springfox<\/groupId>     <artifactId>springfox-swagger-ui<\/artifactId>     <version>2.2.2<\/version><\/code><\/pre>\n
<\/dependency>
<dependency><\/p>\n
    <groupId>org.codehaus.jackson<\/groupId>     <artifactId>jackson-core-asl<\/artifactId>     <version>1.9.13<\/version><\/code><\/pre>\n
<\/dependency>
\u00a0\u7b2c\u4e00\u4e2a\u662fAPI\u83b7\u53d6\u7684\u5305<\/p>\n
\u7b2c\u4e8c\u662f\u5b98\u65b9\u7ed9\u51fa\u7684\u4e00\u4e2aui\u754c\u9762\uff0c\u8fd9\u4e2a\u754c\u9762\u53ef\u4ee5\u81ea\u5b9a\u4e49\uff0c\u9ed8\u8ba4\u662f\u5b98\u65b9\u7684<\/p>\n
\u7b2c\u4e09\u4e2a\u662f\u6d4b\u8bd5\u6570\u636e\u4ee5JSON\u683c\u5f0f\u8fd4\u56de\u7684\u4f9d\u8d56\u5305<\/p>\n
2.\u914d\u7f6eSwagger\u00a0<\/p>\n
\u65b0\u5efaSwagger\u914d\u7f6e\u7c7b\uff0c\u9700\u8981\u7279\u522b\u6ce8\u610f\u7684\u662fSwagger scan base package,\u8fd9\u662f\u626b\u63cf\u6ce8\u89e3\u7684\u914d\u7f6e\uff0c\u5373\u4f60\u7684API\u63a5\u53e3\u4f4d\u7f6e\uff0c\u5bf9\u524d\u7aef\u63d0\u4f9b\u670d\u52a1\u63a5\u53e3\u7684\u4f4d\u7f6e\u3002<\/p>\n
package com.example.demo.config;
@Configuration
@EnableSwagger2
public class SwaggerConfig {<\/p>\n
private ApiInfo apiInfo() {     return new ApiInfoBuilder().title("API\u63a5\u53e3\u6587\u6863")             .description("\u7528\u6237\u4fe1\u606f\u7ba1\u7406")             .version("1.0.0")             .build(); } @Bean public Docket createRestApi() {     return new Docket(DocumentationType.SWAGGER_2)             .apiInfo(apiInfo())             .select()             .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) \/\/\u8fd9\u91cc\u5199\u7684\u662fAPI\u63a5\u53e3\u6240\u5728\u7684\u5305\u4f4d\u7f6e              .paths(PathSelectors.any())             .build(); }<\/code><\/pre>\n
}
3.\u7b80\u5355\u5199\u4e2aDao\u548cUser\u5b9e\u4f53\u7c7b<\/p>\n
package com.example.demo.dao;<\/p>\n
import com.example.demo.entity.User;
public interface UserDao {<\/p>\n
User findById(Integer id); User findByName(String name); <\/code><\/pre>\n
}<\/p>\n
public class User {<\/p>\n
int id;\/\/\u7528\u6237ID String name;\/\/\u59d3\u540d  public void setId(int id){          this.id=id; } public int getId(){          return id; } public void setName(String name){     this.name=name; } public String getName(){          return name; }<\/code><\/pre>\n
4.\u64b0\u5199Controller\uff08UserController\uff09<\/p>\n
@RestController
@RequestMapping(“\/user”)
@Api(value = “\u7528\u6237\u4fe1\u606f\u7ba1\u7406”)
public class UserController {
UserDao userDao;<\/p>\n
     @RequestMapping(method = RequestMethod.POST,value = "\/userById") @ApiOperation(value = "\u83b7\u53d6\u7528\u6237\u4fe1\u606f", notes = "\u901a\u8fc7\u7528\u6237ID\u83b7\u53d6\u7528\u6237\u4fe1\u606f") public Object findById(@ApiParam(value = "\u7528\u6237ID",required = true) int id){     return userDao.findById(id); }  @RequestMapping(method = RequestMethod.POST,value = "\/userByName") @ApiOperation(value = "\u83b7\u53d6\u7528\u6237\u4fe1\u606f", notes = "\u901a\u8fc7\u7528\u6237\u59d3\u540d\u83b7\u53d6\u7528\u6237\u4fe1\u606f") public Object findByName(@ApiParam(value = "\u7528\u6237\u59d3\u540d",required = true) String  name){ return userDao.findByName(name);  } <\/code><\/pre>\n
}
5.\u8bbe\u5b9a\u8bbf\u95eeAPI\u6587\u6863\u7684\u8def\u7531<\/p>\n
\u5728\u914d\u7f6e\u6587\u4ef6\u4e2d\uff0capplication.yml\u4e2d\u58f0\u660e\uff1a<\/p>\n
springfox.documentation.swagger.v2.path: \/api-docs<\/p>\n
\u8fd9\u4e2apath\u5c31\u662fjson\u7684\u8bbf\u95eerequest mapping.\u53ef\u4ee5\u81ea\u5b9a\u4e49\uff0c\u9632\u6b62\u4e0e\u81ea\u8eab\u4ee3\u7801\u51b2\u7a81\u3002<\/p>\n
API doc\u7684\u663e\u793a\u8def\u7531\u662f\uff1ahttp:\/\/localhost<\/a>:8080\/swagger-ui.html<\/p>\n
\u00a0<\/p>\n
Swagger\u5e38\u7528\u6ce8\u89e3<\/h3>\n
1\u3001Api\u6807\u8bb0<\/p>\n
Api \u7528\u5728\u7c7b\u4e0a\uff0c\u8bf4\u660e\u8be5\u7c7b\u7684\u4f5c\u7528\u3002\u53ef\u4ee5\u6807\u8bb0\u4e00\u4e2aController\u7c7b\u505a\u4e3aswagger \u6587\u6863\u8d44\u6e90\uff0c\u4f7f\u7528\u65b9\u5f0f\uff1a
@Api(value = “\/user”, description = “Operations about user”)\u00a0<\/p>\n
2\u3001ApiOperation\u6807\u8bb0<\/p>\n
ApiOperation\uff1a\u7528\u5728\u65b9\u6cd5\u4e0a\uff0c\u8bf4\u660e\u65b9\u6cd5\u7684\u4f5c\u7528\uff0c\u6bcf\u4e00\u4e2aurl\u8d44\u6e90\u7684\u5b9a\u4e49,\u4f7f\u7528\u65b9\u5f0f\uff1a<\/p>\n
@ApiOperation(<\/p>\n
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0value\u00a0= “Find purchase order by ID”,<\/p>\n
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0notes = “For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions”,<\/p>\n
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0response = Order,<\/p>\n
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0tags = {“Pet Store”})<\/p>\n
3\u3001ApiParam\u6807\u8bb0<\/p>\n
ApiParam\u8bf7\u6c42\u5c5e\u6027,\u4f7f\u7528\u65b9\u5f0f\uff1a<\/p>\n
public\u00a0ResponseEntity<User> createUser(@RequestBody @ApiParam(value\u00a0= “Created user object”, required = true) \u00a0User user)<\/p>\n
    \n
  1. \u00a0ApiResponse<\/li>\n<\/ol>\n
    ApiResponse\uff1a\u54cd\u5e94\u914d\u7f6e\uff0c\u4f7f\u7528\u65b9\u5f0f\uff1a\u00a0
    @ApiResponse(code = 400, message = “Invalid user supplied”)\u00a0<\/p>\n
      \n
    1. \u00a0ApiResponses<\/li>\n<\/ol>\n
      ApiResponses\uff1a\u54cd\u5e94\u96c6\u914d\u7f6e\uff0c\u4f7f\u7528\u65b9\u5f0f\uff1a\u00a0
      @ApiResponses({ @ApiResponse(code = 400, message = “Invalid Order”) })\u00a0<\/p>\n
        \n
      1. \u00a0ResponseHeader<\/li>\n<\/ol>\n
        \u54cd\u5e94\u5934\u8bbe\u7f6e\uff0c\u4f7f\u7528\u65b9\u6cd5\u00a0
        @ResponseHeader(name=”head1″,description=”response head conf”)\u00a0<\/p>\n
        @Api()\u7528\u4e8e\u7c7b\uff1b\u00a0
        \u8868\u793a\u6807\u8bc6\u8fd9\u4e2a\u7c7b\u662fswagger\u7684\u8d44\u6e90\u00a0
        @ApiOperation()\u7528\u4e8e\u65b9\u6cd5\uff1b\u00a0
        \u8868\u793a\u4e00\u4e2ahttp\u8bf7\u6c42\u7684\u64cd\u4f5c\u00a0
        @ApiParam()\u7528\u4e8e\u65b9\u6cd5\uff0c\u53c2\u6570\uff0c\u5b57\u6bb5\u8bf4\u660e\uff1b\u00a0
        \u8868\u793a\u5bf9\u53c2\u6570\u7684\u6dfb\u52a0\u5143\u6570\u636e\uff08\u8bf4\u660e\u6216\u662f\u5426\u5fc5\u586b\u7b49\uff09\u00a0
        @ApiModel()\u7528\u4e8e\u7c7b\u00a0
        \u8868\u793a\u5bf9\u7c7b\u8fdb\u884c\u8bf4\u660e\uff0c\u7528\u4e8e\u53c2\u6570\u7528\u5b9e\u4f53\u7c7b\u63a5\u6536\u00a0
        @ApiModelProperty()\u7528\u4e8e\u65b9\u6cd5\uff0c\u5b57\u6bb5\u00a0
        \u8868\u793a\u5bf9model\u5c5e\u6027\u7684\u8bf4\u660e\u6216\u8005\u6570\u636e\u64cd\u4f5c\u66f4\u6539\u00a0
        @ApiIgnore()\u7528\u4e8e\u7c7b\uff0c\u65b9\u6cd5\uff0c\u65b9\u6cd5\u53c2\u6570\u00a0
        \u8868\u793a\u8fd9\u4e2a\u65b9\u6cd5\u6216\u8005\u7c7b\u88ab\u5ffd\u7565\u00a0
        \u00a0@ApiImplicitParam()\u00a0\u7528\u4e8e\u65b9\u6cd5\u00a0
        \u8868\u793a\u5355\u72ec\u7684\u8bf7\u6c42\u53c2\u6570\u00a0
        \u00a0@ApiImplicitParams()\u00a0\u7528\u4e8e\u65b9\u6cd5\uff0c\u5305\u542b\u591a\u4e2a @ApiImplicitParam
        \u00a0@Api()\u00a0
        \u7528\u4e8e\u7c7b\uff1b\u8868\u793a\u6807\u8bc6\u8fd9\u4e2a\u7c7b\u662fswagger\u7684\u8d44\u6e90\u00a0
        tags\u2013\u8868\u793a\u8bf4\u660e\u00a0
        value\u2013\u4e5f\u662f\u8bf4\u660e\uff0c\u53ef\u4ee5\u4f7f\u7528tags\u66ff\u4ee3\u00a0
        \u4f46\u662ftags\u5982\u679c\u6709\u591a\u4e2a\u503c\uff0c\u4f1a\u751f\u6210\u591a\u4e2alist<\/p>\n
        @Api(value=”\u7528\u6237controller”,tags={“\u7528\u6237\u64cd\u4f5c\u63a5\u53e3”})<\/p>\n
        @RestController\u00a0<\/p>\n
        public\u00a0class\u00a0UserController {<\/p>\n
        }<\/p>\n
        @ApiOperation()\u00a0\u7528\u4e8e\u65b9\u6cd5\uff1b\u8868\u793a\u4e00\u4e2ahttp\u8bf7\u6c42\u7684\u64cd\u4f5c\u00a0
        value\u7528\u4e8e\u65b9\u6cd5\u63cf\u8ff0\u00a0
        notes\u7528\u4e8e\u63d0\u793a\u5185\u5bb9\u00a0
        tags\u53ef\u4ee5\u91cd\u65b0\u5206\u7ec4\uff08\u89c6\u60c5\u51b5\u800c\u7528\uff09\u00a0
        @ApiParam()\u00a0\u7528\u4e8e\u65b9\u6cd5\uff0c\u53c2\u6570\uff0c\u5b57\u6bb5\u8bf4\u660e\uff1b\u8868\u793a\u5bf9\u53c2\u6570\u7684\u6dfb\u52a0\u5143\u6570\u636e\uff08\u8bf4\u660e\u6216\u662f\u5426\u5fc5\u586b\u7b49\uff09\u00a0
        name\u2013\u53c2\u6570\u540d\u00a0
        value\u2013\u53c2\u6570\u8bf4\u660e\u00a0
        required\u2013\u662f\u5426\u5fc5\u586b<\/p>\n
        @ApiModel()\u7528\u4e8e\u7c7b \uff1b\u8868\u793a\u5bf9\u7c7b\u8fdb\u884c\u8bf4\u660e\uff0c\u7528\u4e8e\u53c2\u6570\u7528\u5b9e\u4f53\u7c7b\u63a5\u6536\u00a0
        value\u2013\u8868\u793a\u5bf9\u8c61\u540d\u00a0
        description\u2013\u63cf\u8ff0\u00a0
        \u90fd\u53ef\u7701\u7565\u00a0
        @ApiModelProperty()\u7528\u4e8e\u65b9\u6cd5\uff0c\u5b57\u6bb5\uff1b \u8868\u793a\u5bf9model\u5c5e\u6027\u7684\u8bf4\u660e\u6216\u8005\u6570\u636e\u64cd\u4f5c\u66f4\u6539\u00a0
        value\u2013\u5b57\u6bb5\u8bf4\u660e\u00a0
        name\u2013\u91cd\u5199\u5c5e\u6027\u540d\u5b57\u00a0
        dataType\u2013\u91cd\u5199\u5c5e\u6027\u7c7b\u578b\u00a0
        required\u2013\u662f\u5426\u5fc5\u586b\u00a0
        example\u2013\u4e3e\u4f8b\u8bf4\u660e\u00a0
        hidden\u2013\u9690\u85cf<\/p>\n
        @ApiIgnore()\u7528\u4e8e\u7c7b\u6216\u8005\u65b9\u6cd5\u4e0a\uff0c\u53ef\u4ee5\u4e0d\u88abswagger\u663e\u793a\u5728\u9875\u9762\u4e0a\u00a0
        \u6bd4\u8f83\u7b80\u5355, \u8fd9\u91cc\u4e0d\u505a\u4e3e\u4f8b<\/p>\n
        @ApiImplicitParam()\u00a0\u7528\u4e8e\u65b9\u6cd5\u00a0
        \u8868\u793a\u5355\u72ec\u7684\u8bf7\u6c42\u53c2\u6570\u00a0
        @ApiImplicitParams()\u00a0\u7528\u4e8e\u65b9\u6cd5\uff0c\u5305\u542b\u591a\u4e2a @ApiImplicitParam\u00a0
        name\u2013\u53c2\u6570ming\u00a0
        value\u2013\u53c2\u6570\u8bf4\u660e\u00a0
        dataType\u2013\u6570\u636e\u7c7b\u578b\u00a0
        paramType\u2013\u53c2\u6570\u7c7b\u578b\u00a0
        example\u2013\u4e3e\u4f8b\u8bf4\u660e<\/p>\n
        ———————————>\u57fa\u7840\u7bc7<\/p>\n