{"id":871,"date":"2021-04-17T12:50:00","date_gmt":"2021-04-17T04:50:00","guid":{"rendered":"http:\/\/www.langmanezhuang.com\/index.php\/2021\/04\/17\/springboot%e9%9b%86%e6%88%90swagger\/"},"modified":"2021-04-17T12:50:00","modified_gmt":"2021-04-17T04:50:00","slug":"springboot%e9%9b%86%e6%88%90swagger","status":"publish","type":"post","link":"http:\/\/blog.langmanezhuang.com\/index.php\/2021\/04\/17\/springboot%e9%9b%86%e6%88%90swagger\/","title":{"rendered":"Springboot\u96c6\u6210swagger"},"content":{"rendered":"

1.\u5f15\u5165jar\u5305<\/p>\n

\n
\t\t<!-- springfox-swagger -->\n\t    <dependency>\n\t        <groupId>io.springfox<\/groupId>\n\t        <artifactId>springfox-boot-starter<\/artifactId>\n\t        <version>3.0.0<\/version>\n\t    <\/dependency>\n<\/pre>\n<\/div>\n
2.\u7f16\u5199\u914d\u7f6e\u7c7b<\/p>\n
\n
package com.qyc.Microservice.config;\n\nimport org.springframework.beans.factory.annotation.Autowired;\nimport org.springframework.context.annotation.Bean;\nimport org.springframework.context.annotation.Configuration;\nimport org.springframework.core.env.AbstractEnvironment;\n\nimport springfox.documentation.builders.ApiInfoBuilder;\nimport springfox.documentation.builders.PathSelectors;\nimport springfox.documentation.builders.RequestHandlerSelectors;\nimport springfox.documentation.service.Contact;\nimport springfox.documentation.spi.DocumentationType;\nimport springfox.documentation.spring.web.plugins.Docket;\nimport springfox.documentation.swagger2.annotations.EnableSwagger2;\n\n\n\/**\n * \u8bbf\u95ee\u5730\u5740\uff1a\n *   \/swagger-ui\/index.html\n *\/\n@Configuration\n@EnableSwagger2\npublic class SwaggerConfig {\n\t\n    @Autowired\n    private AbstractEnvironment env;\n\t\n    @Bean\n    public Docket createRestApi() {\n    \t\/\/\u662f\u5426\u5f00\u542fswagger\uff0c\u6b63\u5f0f\u73af\u5883\u4e00\u822c\u662f\u9700\u8981\u5173\u95ed\u7684\uff08\u907f\u514d\u4e0d\u5fc5\u8981\u7684\u6f0f\u6d1e\u66b4\u9732\uff01\uff09\uff0c\u53ef\u6839\u636espringboot\u7684\u591a\u73af\u5883\u914d\u7f6e\u8fdb\u884c\u8bbe\u7f6e\n    \tString swaggerflag = env.getProperty(\"swagger.enable\");\n    \t\n    \tif(\"true\".equals(swaggerflag)){\n            return new Docket(DocumentationType.SWAGGER_2)\n                    .pathMapping(\"\/\")\n                    .select()\n                    .apis(RequestHandlerSelectors.basePackage(\"com.qyc.Microservice.controller\"))\n                    .paths(PathSelectors.any())\n                    .build().apiInfo(new ApiInfoBuilder()\n                            .title(\"\u9879\u76ee\u63a5\u53e3\u63a5\u53e3\u8bf4\u660e\")\n                            .description(\"\u8be6\u7ec6\u4fe1\u606f......\")\n                            .version(\"1.0\")\n                            .contact(new Contact(\"JoePotter\",\"https:\/\/www.cnblogs.com\/JoePotter\/\",\"252177507@qq.com\"))\n                            .license(\"The Apache License\")\n                            .licenseUrl(\"https:\/\/www.cnblogs.com\/JoePotter\/\")\n                            .build());\n    \t}else {\n            return new Docket(DocumentationType.SWAGGER_2)\n                    .pathMapping(\"\/\")\n                    .select()\n                    .apis(RequestHandlerSelectors.basePackage(\"com.qyc.Microservice.controller\"))\n                    .paths(PathSelectors.any())\n                    .build().apiInfo(new ApiInfoBuilder()\n                            .title(\"\u9879\u76ee\u63a5\u53e3\u63a5\u53e3\u8bf4\u660e\")\n                            .description(\"\u8be6\u7ec6\u4fe1\u606f......\")\n                            .version(\"1.0\")\n                            .contact(new Contact(\"JoePotter\",\"https:\/\/www.cnblogs.com\/JoePotter\/\",\"252177507@qq.com\"))\n                            .license(\"The Apache License\")\n                            .licenseUrl(\"https:\/\/www.cnblogs.com\/JoePotter\/\")\n                            .build()).enable(false);\n    \t}\n    }\n}\n<\/pre>\n<\/div>\n
3.\u5bf9\u63a5\u53e3\u548c\u5b9e\u4f53\u7c7b\u6dfb\u52a0\u6ce8\u91ca\uff0c\u751f\u6210doc\u3002\u5e38\u7528\u7684\u6807\u8bb0\u5982\u4e0b<\/p>\n
@Api()\u7528\u4e8e\u7c7b\uff1b
\u6807\u8bc6\u8fd9\u4e2a\u7c7b\u662fswagger\u7684\u8d44\u6e90
\u3000\u3000tags–\u8868\u793a\u5206\u7ec4\u8bf4\u660e\u6807\u7b7e<\/p>\n
@ApiOperation()\u7528\u4e8e\u65b9\u6cd5\uff1b
\u8868\u793a\u4e00\u4e2ahttp\u8bf7\u6c42\u7684\u64cd\u4f5c
\u3000\u3000value\u7528\u4e8e\u65b9\u6cd5\u63cf\u8ff0 <\/p>\n
\u3000\u3000notes\u7528\u4e8e\u63d0\u793a\u5185\u5bb9<\/p>\n
@ApiModel()\u7528\u4e8e\u5b9e\u4f53\u7c7b
\u8868\u793a\u5bf9\u7c7b\u8fdb\u884c\u8bf4\u660e\uff0c\u7528\u4e8e\u53c2\u6570\u7528\u5b9e\u4f53\u7c7b\u63a5\u6536<\/p>\n
      value–\u8868\u793a\u5bf9\u8c61\u540d 
      description–\u63cf\u8ff0<\/p>\n
@ApiModelProperty()\u7528\u4e8e\u5b9e\u4f53\u7c7b\u5b57\u6bb5
\u8868\u793a\u5bf9model\u5c5e\u6027\u7684\u8bf4\u660e\u6216\u8005\u6570\u636e\u64cd\u4f5c\u66f4\u6539
\u3000\u3000value–\u5b57\u6bb5\u8bf4\u660e 
\u3000\u3000name–\u91cd\u5199\u5c5e\u6027\u540d\u5b57 
\u3000\u3000dataType–\u91cd\u5199\u5c5e\u6027\u7c7b\u578b 
\u3000\u3000required–\u662f\u5426\u5fc5\u586b 
\u3000\u3000example–\u4e3e\u4f8b\u8bf4\u660e 
\u3000\u3000hidden–\u9690\u85cf<\/p>\n
@ApiImplicitParam() \u7528\u4e8e controller \u65b9\u6cd5
\u8868\u793a\u5355\u72ec\u7684\u8bf7\u6c42\u53c2\u6570
\u3000\u3000name–\u53c2\u6570ming
\u3000\u3000value–\u53c2\u6570\u8bf4\u660e
\u3000\u3000dataType–\u6570\u636e\u7c7b\u578b
\u3000\u3000paramType–\u53c2\u6570\u7c7b\u578b
\u3000\u3000example–\u4e3e\u4f8b\u8bf4\u660e<\/p>\n
@ApiImplicitParams() \u7528\u4e8e controller \u65b9\u6cd5\uff0c\u5305\u542b\u591a\u4e2a @ApiImplicitParam<\/p>\n
@ApiIgnore()\u7528\u4e8e\u7c7b\u6216\u8005\u65b9\u6cd5\u4e0a\uff0c\u53ef\u4ee5\u4e0d\u88abswagger\u663e\u793a\u5728\u9875\u9762\u4e0a<\/p>\n
\u8bf4\u660e\uff1a\u7b80\u5355\u7684\u6807\u8bb0\u53ea\u9700\u8981@Api(tags=””) \u548c @ApiOperation(value=””,notes=””)<\/span><\/p>\n
\n
@RestController\n@RequestMapping(\"\/user\")\n@Api(tags = \"\u7528\u6237\u767b\u5f55\")<\/span>\npublic class LoginController extends BaseController {\n\n\t@Autowired\n\tprivate UserService userService;\n\t\n\t@PostMapping(\"\/save\")\n\t@ApiOperation(value = \"\u65b0\u5efa\u7528\u6237\uff01\",notes = \"\u63d0\u793a\u4fe1\u606f\u3002\")<\/span>\n\tpublic void save(@Valid User user) {\n\t\tuserService.saveMapper( user);\n\t}\n<\/pre>\n<\/div>\n
\u3000\u3000<\/p>\n
 <\/p>\n","protected":false},"excerpt":{"rendered":"
1.\u5f15\u5165jar\u5305 <!– springfox-swagger –> <dependenc … \u7ee7\u7eed\u9605\u8bfb Springboot\u96c6\u6210swagger<\/span> →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"_links":{"self":[{"href":"http:\/\/blog.langmanezhuang.com\/index.php\/wp-json\/wp\/v2\/posts\/871"}],"collection":[{"href":"http:\/\/blog.langmanezhuang.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/blog.langmanezhuang.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/blog.langmanezhuang.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/blog.langmanezhuang.com\/index.php\/wp-json\/wp\/v2\/comments?post=871"}],"version-history":[{"count":0,"href":"http:\/\/blog.langmanezhuang.com\/index.php\/wp-json\/wp\/v2\/posts\/871\/revisions"}],"wp:attachment":[{"href":"http:\/\/blog.langmanezhuang.com\/index.php\/wp-json\/wp\/v2\/media?parent=871"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/blog.langmanezhuang.com\/index.php\/wp-json\/wp\/v2\/categories?post=871"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/blog.langmanezhuang.com\/index.php\/wp-json\/wp\/v2\/tags?post=871"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}