{"id":1036,"date":"2024-11-13T21:25:48","date_gmt":"2024-11-13T13:25:48","guid":{"rendered":"https:\/\/www.coffecat.cn\/?p=1036"},"modified":"2024-11-13T21:25:48","modified_gmt":"2024-11-13T13:25:48","slug":"springboot%e9%9b%86%e6%88%90swagger%e6%8e%a5%e5%8f%a3%e6%96%87%e6%a1%a3%e8%b8%a9%e5%9d%91%e8%ae%b0%e5%bd%95","status":"publish","type":"post","link":"https:\/\/www.coffecat.cn\/index.php\/2024\/11\/13\/springboot%e9%9b%86%e6%88%90swagger%e6%8e%a5%e5%8f%a3%e6%96%87%e6%a1%a3%e8%b8%a9%e5%9d%91%e8%ae%b0%e5%bd%95\/","title":{"rendered":"springboot\u96c6\u6210swagger\u63a5\u53e3\u6587\u6863\u8e29\u5751\u8bb0\u5f55"},"content":{"rendered":"\n

\u8d77\u56e0\uff1a\u56e0\u4e3a\u81ea\u5df1\u5728\u505a\u7684\u540e\u7aef\u9879\u76ee\u4e2d\u6ca1\u6709swagger\u63a5\u53e3\u6587\u6863\uff0c\u6240\u4ee5\u60f3\u96c6\u6210\u4e00\u4e0b\uff0c\u540e\u9762\u53ef\u80fd\u4f1a\u7528\u5230\uff0c\u5f53\u6211\u6839\u636e\u96c6\u6210\u64cd\u4f5c\u6307\u5357\u8fdb\u884c\u96c6\u6210\u65f6\u53d1\u73b0\u5728\u542f\u52a8\u9879\u76ee\u65f6\u4f1a\u62a5\u9519\uff0c\u62a5\u9519\u4fe1\u606f\u5982\u4e0b<\/p>\n\n\n\n

<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
Failed<\/span> <\/span>to<\/span> <\/span>start<\/span> <\/span>bean<\/span> <\/span>\u2018documentationPluginsBootstrapper\u2019<\/span>;<\/span> <\/span>nested<\/span> <\/span>exception<\/span> <\/span>is<\/span> <\/span>java.lang.NullPointerException<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
\u610f\u601d\u662f\u8bf4\u5728springboot\u542f\u52a8\u65f6\u5728\u5bb9\u5668\u4e2d\u6ca1\u6709\u52a0\u8f7d\u5230\u8fd9\u4e2abean\u5bfc\u81f4npe<\/p>\n\n\n\n
\u5728\u7f51\u4e0a\u67e5\u4e86\u4e00\u4e0b\u8bf4\u662fspringboot\u7248\u672c\u95ee\u9898\uff0c\u7531\u4e8espringboot\u7248\u672c\u8fc7\u9ad8\u5bfc\u81f4\u4e0eswagger\u4e0d\u517c\u5bb9\uff0c\u4e8e\u662f\u5c31\u6539\u4e86\u4e00\u4e0bspringboot\u7684\u7248\u672c\uff0c\u4ece\u76ee\u524d\u4f7f\u7528\u76842.6.13\u6539\u6210\u4e862.3.0\uff0c\u7ed3\u679c\u53d1\u73b0mysql\u542f\u52a8\u5668\u5c31\u8ddf\u7740\u62a5\u9519\u4e86\uff0c\u5f53\u6539\u6210\u5408\u9002\u7684mysql\u7248\u672c\u540e\u53d1\u73b0\u8fde\u63a5\u6c60\u62a5\u9519\uff0c\u8fd9\u4e2a\u65b9\u6cd5\u5c31\u653e\u5f03\u4e86\uff0c\u5982\u679c\u76f4\u63a5\u4fee\u6539springboot\u7248\u672c\u4f1a\u5bfc\u81f4\u4e00\u8fde\u4e32\u7684\u95ee\u9898\u3002<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
<spring-boot.version><\/span>2.6.13<\/span><\/spring-boot.version><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
\u4e8e\u662f\u5c31\u6539\u4e86swagger\u7684\u7248\u672c\uff0c\u4ece\u539f\u6765\u76842.9.2\u6539\u6210\u4e863.0.0\uff0c\u7136\u540e\u91cd\u542f\u9879\u76ee\uff0c\u53d1\u73b0\u4f9d\u65e7\u62a5\u76f8\u540c\u7684\u9519\u8bef<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
<dependency><\/span><\/span>\n    <\/span><groupId><\/span>io.springfox<\/span><\/groupId><\/span><\/span>\n    <\/span><artifactId><\/span>springfox-swagger2<\/span><\/artifactId><\/span><\/span>\n    <\/span><version><\/span>2.9.2<\/span><\/version><\/span><\/span>\n<\/dependency><\/span><\/span>\n<dependency><\/span><\/span>\n    <\/span><groupId><\/span>io.springfox<\/span><\/groupId><\/span><\/span>\n    <\/span><artifactId><\/span>springfox-swagger-ui<\/span><\/artifactId><\/span><\/span>\n    <\/span><version><\/span>2.9.2<\/span><\/version><\/span><\/span>\n<\/dependency><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
\u4e8e\u662f\u53c8\u641c\u7d22\u4e86\u4e00\u4e0b\uff0c\u5728\u4e00\u4e2a\u535a\u4e3b\u7684\u6587\u7ae0\u4e2d\u63d0\u5230springboot2.6\u7684\u7248\u672c\u95ee\u9898\uff0c\u6e90git\u5730\u5740\uff1a\u3010Spring 5.3\/Spring Boot 2.4 \u652f\u6301 \u00b7\u95ee\u9898 #3462 \u00b7springfox\/springfox \u00b7GitHub\u7684<\/a>\u3011<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\u6240\u4ee5\u5177\u4f53\u539f\u56e0\u5e94\u8be5\u662f\u56e0\u4e3aspringboot\u7248\u672c\u539f\u56e0\u5bfc\u81f4\u7684\uff0c\u56e0\u4e3aSpringfox\u4f7f\u7528\u7684\u8def\u5f84\u5339\u914d\u662f\u57fa\u4e8eAntPathMatcher\u7684\uff0c\u800cSpring Boot 2.6.X\u4f7f\u7528\u7684\u662fPathPatternMatcher\uff0c\u6240\u4ee5\u6211\u5728yml\u4e2d\u8c03\u6574\u4e86matching-strategy\uff0c\u6539\u4e3a\u4e86ANT_PATH_MATCHER<\/em><\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
  <\/span># \u5728\u4e0eswagger\u96c6\u6210\u65f6\u7531\u4e8espringboot\u7248\u672c\u539f\u56e0\u5bfc\u81f4\u65e0\u6cd5\u52a0\u8f7dbean<\/span><\/span>\n  <\/span># Springfox\u4f7f\u7528\u7684\u8def\u5f84\u5339\u914d\u662f\u57fa\u4e8eAntPathMatcher\u7684\uff0c\u800cSpring Boot 2.6.X\u4f7f\u7528\u7684\u662fPathPatternMatcher<\/span><\/span>\n  <\/span>mvc<\/span>:<\/span><\/span>\n    <\/span>pathmatch<\/span>:<\/span><\/span>\n      <\/span>matching-strategy<\/span>:<\/span> <\/span>ANT_PATH_MATCHER<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
\u6539\u5b8c\u540e\u91cd\u542f\u9879\u76ee\uff0c\u53d1\u73b0\u6211\u7684\u9879\u76ee\u8fd8\u662f\u5b58\u5728\u76f8\u540c\u7684\u95ee\u9898\uff0c\u540e\u6765\u5c31\u6ca1\u5728\u4f7f\u7528swagger2\u8fdb\u884c\u96c6\u6210\uff0c\u6539\u7528\u4e86Knife4j\uff0c\u96c6\u6210\u8fc7\u7a0b\u5f88\u987a\u5229\uff0c\u4e0eswagger2\u4e00\u6837\u7b80\u5355\uff08\u672c\u6765\u5c31\u662f\u5bf9swagger\u7684\u589e\u5f3a\uff09\uff0c\u96c6\u6210\u540e\u91cd\u542f\u6ca1\u6709\u62a5\u9519\u3002\u4e0b\u9762\u662f\u6574\u7406\u96c6\u6210\u8fc7\u7a0b\uff1a<\/p>\n\n\n\n
\u6ce8\uff1a\u7531\u4e8e\u6211\u7684\u9879\u76ee\u662f\u4f7f\u7528\u7684springboot2.6.3\u7684\u7248\u672c\u5b58\u5728\u7248\u672c\u95ee\u9898\uff0c\u5982\u679c\u57282.6.x\u4e4b\u524d\u7684\u7248\u672c\uff0c\u53ef\u80fd\u4e0d\u4f1a\u7528\u7c7b\u4f3c\u7684\u95ee\u9898<\/p>\n\n\n\n
\u9996\u5148\u5f15\u5165\u4f9d\u8d56\uff1a<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
<dependency><\/span><\/span>\n    <\/span><groupId><\/span>com.github.xiaoymin<\/span><\/groupId><\/span><\/span>\n    <\/span><artifactId><\/span>knife4j-spring-boot-starter<\/span><\/artifactId><\/span><\/span>\n    <\/span><!--\u5728\u5f15\u7528\u65f6\u8bf7\u5728maven\u4e2d\u592e\u4ed3\u5e93\u641c\u7d222.X\u6700\u65b0\u7248\u672c\u53f7--><\/span><\/span>\n    <\/span><version><\/span>2.0.9<\/span><\/version><\/span><\/span>\n<\/dependency><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
\u5c06matching-strategy\u914d\u7f6e\u4e3aANT_PATH_MATCHER<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
  <\/span># \u5728\u4e0eswagger\u96c6\u6210\u65f6\u7531\u4e8espringboot\u7248\u672c\u539f\u56e0\u5bfc\u81f4\u65e0\u6cd5\u52a0\u8f7dbean<\/span><\/span>\n  <\/span># Springfox\u4f7f\u7528\u7684\u8def\u5f84\u5339\u914d\u662f\u57fa\u4e8eAntPathMatcher\u7684\uff0c\u800cSpring Boot 2.6.X\u4f7f\u7528\u7684\u662fPathPatternMatcher<\/span><\/span>\n  <\/span>mvc<\/span>:<\/span><\/span>\n    <\/span>pathmatch<\/span>:<\/span><\/span>\n      <\/span>matching-strategy<\/span>:<\/span> <\/span>ANT_PATH_MATCHER<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
\u521b\u5efaSwagger\u914d\u7f6e\u4f9d\u8d56\uff0c\u8fd9\u91cc\u662f\u5b98\u7f51\u7248\u672c\uff0c\u4e5f\u53ef\u4ee5\u5c06apiInfo\u5355\u72ec\u5199\u4e00\u4e2a\u65b9\u6cd5\uff0c\u8fd9\u91cc\u4f7f\u7528\u7684\u6ce8\u89e3\u5c31\u4e0d\u518d\u662f@EnableSwagger2\u4e86\u800c\u6539\u4e3a\u4e86@EnableSwagger2WebMvc<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
@<\/span>Configuration<\/span><\/span>\n@<\/span>EnableSwagger2WebMvc<\/span><\/span>\npublic<\/span> <\/span>class<\/span> <\/span>Knife4jConfiguration<\/span> <\/span>{<\/span><\/span>\n<\/span>\n    <\/span>@<\/span>Bean<\/span>(<\/span>value<\/span> <\/span>=<\/span> <\/span>"<\/span>defaultApi2<\/span>"<\/span>)<\/span><\/span>\n    <\/span>public<\/span> <\/span>Docket<\/span> <\/span>defaultApi2<\/span>()<\/span> <\/span>{<\/span><\/span>\n        <\/span>Docket<\/span> <\/span>docket<\/span>=new<\/span> <\/span>Docket<\/span>(<\/span>DocumentationType<\/span>.<\/span>SWAGGER_2<\/span>)<\/span><\/span>\n                <\/span>.<\/span>apiInfo<\/span>(<\/span>new<\/span> <\/span>ApiInfoBuilder<\/span>()<\/span><\/span>\n                        <\/span>\/\/.title("swagger-bootstrap-ui-demo RESTful APIs")<\/span><\/span>\n                        <\/span>.<\/span>description<\/span>(<\/span>"<\/span># swagger-bootstrap-ui-demo RESTful APIs<\/span>"<\/span>)<\/span><\/span>\n                        <\/span>.<\/span>termsOfServiceUrl<\/span>(<\/span>"<\/span>http:\/\/www.xx.com\/<\/span>"<\/span>)<\/span><\/span>\n                        <\/span>.<\/span>contact<\/span>(<\/span>"<\/span>xx@qq.com<\/span>"<\/span>)<\/span><\/span>\n                        <\/span>.<\/span>version<\/span>(<\/span>"<\/span>1.0<\/span>"<\/span>)<\/span><\/span>\n                        <\/span>.<\/span>build<\/span>())<\/span><\/span>\n                <\/span>\/\/\u5206\u7ec4\u540d\u79f0<\/span><\/span>\n                <\/span>.<\/span>groupName<\/span>(<\/span>"<\/span>2.X\u7248\u672c<\/span>"<\/span>)<\/span><\/span>\n                <\/span>.<\/span>select<\/span>()<\/span><\/span>\n                <\/span>\/\/\u8fd9\u91cc\u6307\u5b9aController\u626b\u63cf\u5305\u8def\u5f84<\/span><\/span>\n                <\/span>.<\/span>apis<\/span>(<\/span>RequestHandlerSelectors<\/span>.<\/span>basePackage<\/span>(<\/span>"<\/span>com.github.xiaoymin.knife4j.controller<\/span>"<\/span>))<\/span><\/span>\n                <\/span>.<\/span>paths<\/span>(<\/span>PathSelectors<\/span>.<\/span>any<\/span>())<\/span><\/span>\n                <\/span>.<\/span>build<\/span>()<\/span>;<\/span><\/span>\n        <\/span>return<\/span> docket<\/span>;<\/span><\/span>\n    <\/span>}<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
\u4e4b\u540e\u5c31\u662f\u6b63\u5e38\u7f16\u5199\u63a5\u53e3\uff0c\u5728\u63a5\u53e3\u65b9\u6cd5\u4e0a\u6dfb\u52a0@Api\u6ce8\u89e3\u4e0e@ApiOperation\u6ce8\u89e3\uff0c\u5728\u6ce8\u89e3\u4e2d\u914d\u7f6e\u63a5\u53e3\u7684\u63cf\u8ff0\u7b49\u4fe1\u606f\uff08\u5b98\u7f51\u793a\u4f8b\uff09<\/p>\n\n\n\n
<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
@<\/span>Api<\/span>(<\/span>tags<\/span> <\/span>=<\/span> <\/span>"<\/span>\u9996\u9875\u6a21\u5757<\/span>"<\/span>)<\/span><\/span>\n@<\/span>RestController<\/span><\/span>\npublic<\/span> <\/span>class<\/span> <\/span>IndexController<\/span> <\/span>{<\/span><\/span>\n<\/span>\n    <\/span>@<\/span>ApiImplicitParam<\/span>(<\/span>name<\/span> <\/span>=<\/span> <\/span>"<\/span>name<\/span>"<\/span>,<\/span>value<\/span> <\/span>=<\/span> <\/span>"<\/span>\u59d3\u540d<\/span>"<\/span>,<\/span>required<\/span> <\/span>=<\/span> <\/span>true<\/span>)<\/span><\/span>\n    <\/span>@<\/span>ApiOperation<\/span>(<\/span>value<\/span> <\/span>=<\/span> <\/span>"<\/span>\u5411\u5ba2\u4eba\u95ee\u597d<\/span>"<\/span>)<\/span><\/span>\n    <\/span>@<\/span>GetMapping<\/span>(<\/span>"<\/span>\/sayHi<\/span>"<\/span>)<\/span><\/span>\n    <\/span>public<\/span> <\/span>ResponseEntity<\/span><<\/span>String<\/span>><\/span> <\/span>sayHi<\/span>(@<\/span>RequestParam<\/span>(<\/span>value<\/span> <\/span>=<\/span> <\/span>"<\/span>name<\/span>"<\/span>)<\/span>String<\/span> <\/span>name<\/span>){<\/span><\/span>\n        <\/span>return<\/span> <\/span>ResponseEntity<\/span>.<\/span>ok<\/span>(<\/span>"<\/span>Hi:<\/span>"<\/span>+<\/span>name<\/span>)<\/span>;<\/span><\/span>\n    <\/span>}<\/span><\/span>\n}<\/span><\/span>\n<\/span><\/code><\/pre><\/div>\n\n\n\n
\u91cd\u542f\u9879\u76ee\uff0c\u8bbf\u95ee\uff1ahttp:\/\/localhost(ip):xxx(port)\/doc.html<\/code><\/p>\n\n\n\n
\"\"<\/figure>\n","protected":false},"excerpt":{"rendered":"
\u8d77\u56e0\uff1a\u56e0\u4e3a\u81ea\u5df1\u5728\u505a\u7684\u540e\u7aef\u9879\u76ee\u4e2d\u6ca1\u6709swagger\u63a5\u53e3\u6587\u6863\uff0c\u6240\u4ee5\u60f3\u96c6\u6210\u4e00\u4e0b\uff0c\u540e\u9762\u53ef\u80fd\u4f1a\u7528\u5230\uff0c\u5f53\u6211\u6839\u636e\u96c6\u6210\u64cd\u4f5c\u6307\u5357 … <\/p>\n
\u7ee7\u7eed\u9605\u8bfb\u201cspringboot\u96c6\u6210swagger\u63a5\u53e3\u6587\u6863\u8e29\u5751\u8bb0\u5f55\u201d<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1,6],"tags":[],"class_list":["post-1036","post","type-post","status-publish","format-standard","hentry","category-uncategorized","category-scatteredtechnicalpoints"],"views":1332,"_links":{"self":[{"href":"https:\/\/www.coffecat.cn\/index.php\/wp-json\/wp\/v2\/posts\/1036","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.coffecat.cn\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.coffecat.cn\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.coffecat.cn\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.coffecat.cn\/index.php\/wp-json\/wp\/v2\/comments?post=1036"}],"version-history":[{"count":12,"href":"https:\/\/www.coffecat.cn\/index.php\/wp-json\/wp\/v2\/posts\/1036\/revisions"}],"predecessor-version":[{"id":1051,"href":"https:\/\/www.coffecat.cn\/index.php\/wp-json\/wp\/v2\/posts\/1036\/revisions\/1051"}],"wp:attachment":[{"href":"https:\/\/www.coffecat.cn\/index.php\/wp-json\/wp\/v2\/media?parent=1036"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.coffecat.cn\/index.php\/wp-json\/wp\/v2\/categories?post=1036"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.coffecat.cn\/index.php\/wp-json\/wp\/v2\/tags?post=1036"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
\u6211\u8fd9\u91cc\u4f7f\u7528\u7684\u662f\u65e7\u7248\u672c\u7684\uff082.0.9\uff09knife4j\uff0c\u5b98\u65b9\u6587\u6863\u5730\u5740\uff1a\u3010knife4j (xiaominfo.com)<\/a>\u3011<\/p>\n\n\n\n