{"id":714,"date":"2023-10-31T09:01:01","date_gmt":"2023-10-31T01:01:01","guid":{"rendered":""},"modified":"2023-10-31T09:01:01","modified_gmt":"2023-10-31T01:01:01","slug":"knife4j\u63a5\u53e3\u6587\u6863\u5de5\u5177\u7684\u4f7f\u7528","status":"publish","type":"post","link":"https:\/\/mushiming.com\/714.html","title":{"rendered":"knife4j\u63a5\u53e3\u6587\u6863\u5de5\u5177\u7684\u4f7f\u7528"},"content":{"rendered":"<p>\u5de5\u5177\u5177\u4f53\u529f\u80fd\u5c31\u4e0d\u591a\u89e3\u91ca\u4e86\uff0c\u76f4\u63a5\u6b65\u5165\u4e3b\u9898<\/p>\n<p>\u5bfc\u5165\u76f8\u5173\u4f9d\u8d56<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-yml\" lang=\"yml\">  <span class=\"hljs-string\">&lt;dependency&gt;<\/span>\n    <span class=\"hljs-string\">&lt;groupId&gt;com.github.xiaoymin&lt;\/groupId&gt;<\/span>\n    <span class=\"hljs-string\">&lt;artifactId&gt;knife4j-spring-boot-starter&lt;\/artifactId&gt;<\/span>\n    <span class=\"hljs-string\">&lt;version&gt;3.0.3&lt;\/version&gt;<\/span>\n<span class=\"hljs-string\">&lt;\/dependency&gt;<\/span>\n<\/code><\/pre>\n<p>\u7136\u540e\u5728config\u6587\u4ef6\u5939\u91cc\u521b\u5efaSwaggerConfig\u7c7b\uff08\u540d\u79f0\u4e0d\u56fa\u5b9a\u53ea\u662f\u4e3a\u4e86\u65b9\u4fbf\u8bc6\u522b\u529f\u80fd\uff09<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-java\" lang=\"java\"><span class=\"hljs-keyword\">package<\/span> com.example.demo.config;\n\n<span class=\"hljs-keyword\">import<\/span> com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;\n<span class=\"hljs-keyword\">import<\/span> org.springframework.context.annotation.Bean;\n<span class=\"hljs-keyword\">import<\/span> org.springframework.context.annotation.Configuration;\n<span class=\"hljs-keyword\">import<\/span> springfox.documentation.builders.ApiInfoBuilder;\n<span class=\"hljs-keyword\">import<\/span> springfox.documentation.builders.PathSelectors;\n<span class=\"hljs-keyword\">import<\/span> springfox.documentation.builders.RequestHandlerSelectors;\n<span class=\"hljs-keyword\">import<\/span> springfox.documentation.oas.annotations.EnableOpenApi;\n<span class=\"hljs-keyword\">import<\/span> springfox.documentation.service.Contact;\n<span class=\"hljs-keyword\">import<\/span> springfox.documentation.spi.DocumentationType;\n<span class=\"hljs-keyword\">import<\/span> springfox.documentation.spring.web.plugins.Docket;\n<span class=\"hljs-keyword\">import<\/span> springfox.documentation.swagger2.annotations.EnableSwagger2;\n\n<span class=\"hljs-meta\">@Configuration<\/span>\n<span class=\"hljs-meta\">@EnableOpenApi<\/span>\n<span class=\"hljs-comment\">\/\/ @EnableKnife4j<\/span>\n<span class=\"hljs-comment\">\/\/ @EnableSwagger2<\/span>\n<span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-keyword\">class<\/span> <span class=\"hljs-title class_\">Knife4jConfig<\/span> {\n    <span class=\"hljs-meta\">@Bean<\/span>\n    <span class=\"hljs-keyword\">public<\/span> Docket <span class=\"hljs-title function_\">docket<\/span><span class=\"hljs-params\">()<\/span> {\n        <span class=\"hljs-type\">Docket<\/span> <span class=\"hljs-variable\">docket<\/span> <span class=\"hljs-operator\">=<\/span> <span class=\"hljs-keyword\">new<\/span> <span class=\"hljs-title class_\">Docket<\/span>(DocumentationType.OAS_30)\n                .apiInfo(<span class=\"hljs-keyword\">new<\/span> <span class=\"hljs-title class_\">ApiInfoBuilder<\/span>()\n                        .title(<span class=\"hljs-string\">\"\u6211\u7684\u6807\u9898\"<\/span>)<span class=\"hljs-comment\">\/\/\u4e0b\u9762\u51e0\u5904\u6587\u5b57\u90fd\u53ef\u4ee5\u6839\u636e\u81ea\u5df1\u9700\u8981\u66f4\u6539<\/span>\n                        .description(<span class=\"hljs-string\">\"\u6211\u7684\u63cf\u8ff0\"<\/span>)\n                        <span class=\"hljs-comment\">\/\/ .termsOfServiceUrl(\"http:\/\/www.xx.com\/\")<\/span>\n                        .contact(<span class=\"hljs-keyword\">new<\/span> <span class=\"hljs-title class_\">Contact<\/span>(<span class=\"hljs-string\">\"corder\"<\/span>, <span class=\"hljs-string\">\"www.juejin.cn\"<\/span>, <span class=\"hljs-string\">\"xx@qq.com\"<\/span>))\n                        .version(<span class=\"hljs-string\">\"1.0\"<\/span>)\n                        .build())\n                <span class=\"hljs-comment\">\/\/ \u5206\u7ec4\u540d\u79f0<\/span>\n                .groupName(<span class=\"hljs-string\">\"all\"<\/span>)\n                .select()\n                <span class=\"hljs-comment\">\/\/ \u8fd9\u91cc\u6307\u5b9aController\u626b\u63cf\u5305\u8def\u5f84\uff08\u6539\u4e3a\u81ea\u5df1\u7684Controller\u7c7b\u7684\u6587\u4ef6\u5939\uff09<\/span>\n                .apis(RequestHandlerSelectors.basePackage(<span class=\"hljs-string\">\"com.example.demo\"<\/span>))\n                .paths(PathSelectors.any())\n                .build();\n\n        <span class=\"hljs-keyword\">return<\/span> docket;\n    }\n}\n<\/code><\/pre>\n<p><strong>\u4e00\u5b9a\u4e0d\u8981\u5fd8\u8bb0\u5728application.yml\u91cc\u8fdb\u884c\u8fd9\u9879mvc\u914d\u7f6e<\/strong><\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-yml\" lang=\"yml\">  <span class=\"hljs-attr\">mvc:<\/span>\n    <span class=\"hljs-attr\">pathmatch:<\/span>\n      <span class=\"hljs-attr\">matching-strategy:<\/span> <span class=\"hljs-string\">ANT_PATH_MATCHER<\/span>\n<\/code><\/pre>\n<p>\u989d\u5916\u914d\u7f6e\uff1a<\/p>\n<p>\u8fd8\u53ef\u4ee5\u5728Controller\u91cc\u6dfb\u52a0@Api(tags = \"\")\u548c @ApiOperation(\"\")\u6ce8\u89e3\u8ba9\u63a5\u53e3\u6587\u6863\u66f4\u6613\u8bfb\uff0c\u5982\u4e0b<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-java\" lang=\"java\"><span class=\"hljs-meta\">@RestController<\/span>\n<span class=\"hljs-meta\">@RequestMapping(\"\/user\")<\/span>\n<span class=\"hljs-meta\">@Api(tags = \"\u7528\u6237\")<\/span>\n<span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-keyword\">class<\/span> <span class=\"hljs-title class_\">UserController<\/span> {\n    <span class=\"hljs-meta\">@Resource<\/span>\n    <span class=\"hljs-keyword\">private<\/span> UserService userService;\n    <span class=\"hljs-comment\">\/\/\u7528\u6237\u6ce8\u518c<\/span>\n    <span class=\"hljs-meta\">@ApiOperation(\"\u6ce8\u518c\")<\/span>\n    <span class=\"hljs-meta\">@PostMapping(\"\/register\")<\/span>\n    <span class=\"hljs-keyword\">public<\/span> BaseResponse&lt;Long&gt; <span class=\"hljs-title function_\">userRegister<\/span><span class=\"hljs-params\">(<span class=\"hljs-meta\">@RequestBody<\/span> UserRegisterRequest registerRequest)<\/span>{\n    \n}\n\n<\/code><\/pre>\n<p><img decoding=\"async\" src=\"https:\/\/p6-juejin.byteimg.com\/tos-cn-i-k3u1fbpfcp\/b64871844aef4d6eb933fca2e14961a2~tplv-k3u1fbpfcp-zoom-in-crop-mark:1512:0:0:0.awebp?\" =\"image.png\" loading=\"lazy\" alt=\"knife4j\u63a5\u53e3\u6587\u6863\u5de5\u5177\u7684\u4f7f\u7528 (https:\/\/mushiming.com\/) \u6280\u672f\u535a\u5ba2 \u7b2c1\u5f20\" title=\"knife4j\u63a5\u53e3\u6587\u6863\u5de5\u5177\u7684\u4f7f\u7528 \u6280\u672f\u535a\u5ba2 \u7b2c1\u5f20-\u7a46\u4e16\u660e\u535a\u5ba2\" ><\/p>\n<p>\u8fd9\u65f6Controller\u7c7b\u548c\u65b9\u6cd5\u5c31\u6709\u4e86\u6613\u8bfb\u7684\u540d\u5b57<\/p>\n","protected":false},"excerpt":{"rendered":"knife4j\u63a5\u53e3\u6587\u6863\u5de5\u5177\u7684\u4f7f\u7528\u5de5\u5177\u5177\u4f53\u529f\u80fd\u5c31\u4e0d\u591a\u89e3\u91ca\u4e86\uff0c\u76f4\u63a5\u6b65\u5165\u4e3b\u9898 \u5bfc\u5165\u76f8\u5173\u4f9d\u8d56 \u7136\u540e\u5728config\u6587\u4ef6\u5939\u91cc\u521b\u5efaSwaggerConfig\u7c7b...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[82],"tags":[],"_links":{"self":[{"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/posts\/714"}],"collection":[{"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/comments?post=714"}],"version-history":[{"count":0,"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/posts\/714\/revisions"}],"wp:attachment":[{"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/media?parent=714"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/categories?post=714"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/tags?post=714"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}