{"id":125,"date":"2025-07-15T01:16:09","date_gmt":"2025-07-14T17:16:09","guid":{"rendered":"http:\/\/192.140.166.102\/?p=125"},"modified":"2025-07-15T01:16:10","modified_gmt":"2025-07-14T17:16:10","slug":"knife4j%e5%92%8cswagger","status":"publish","type":"post","link":"https:\/\/lsuccess.xyz\/index.php\/2025\/07\/15\/knife4j%e5%92%8cswagger\/","title":{"rendered":"Knife4j\u548cSwagger"},"content":{"rendered":"\n<ul class=\"wp-block-list\">\n<li>Knife4j\u4f7f\u7528\u6d41\u7a0b<\/li>\n\n\n\n<li>Knife4j\u5e38\u7528\u6ce8\u89e3<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">\u5728\u540e\u7aef\u5f00\u53d1\u8fc7\u7a0b\u4e2d\u5f53\u6211\u4eec\u5b9e\u73b0\u63a5\u53e3\u529f\u80fd\u7684\u65f6\u5019\uff0c\u5982\u679c\u8981\u6d4b\u8bd5\u7684\u8bdd\uff0c\u4e0d\u4ec5\u8981\u62fc\u63a5URL\u5730\u5740\uff0c\u9891\u7e41\u7684\u6d4b\u8bd5\u8fc7\u7a0b\u4f1a\u4e0d\u65ad\u62fc\u63a5URL\u5730\u5740\uff0c\u4e3a\u4e86\u89e3\u51b3\u8fd9\u4e2a\u95ee\u9898\u6211\u4eec\u4f7f\u7528APIfox\u6765\u6d4b\u8bd5\u4e0d\u884c\u5417\uff1f\u8fd9\u4e2a\u5f53\u7136\u662f\u53ef\u4ee5\u7684\uff0c\u4f46\u8981\u6ce8\u610f\u73b0\u5728\u8fd8\u662f\u5728\u6d4b\u8bd5\u9636\u6bb5\uff0c\u4ee3\u7801\u903b\u8f91\u8fd8\u9700\u8981\u4fee\u6539\uff0c\u5982\u679c\u9891\u7e41\u7684\u4fee\u6539\u5c31\u8981\u4e0d\u65ad\u624b\u52a8\u540c\u6b65\u6211\u4eec\u7684APIfox\uff0c\u6240\u4ee5\u4f7f\u7528Knife4\u6765\u6700\u4e3a\u7a33\u59a5\uff0c\u4e00\u65b9\u9762\u662fKnife4j\u4f1a\u81ea\u52a8\u626b\u63cf\u5e2e\u52a9\u6211\u4eec\u5b8c\u6210\u5f00\u53d1\u6587\u6863\u7684\u642d\u5efa\uff0c\u5176\u6b21\u662f\u540c\u6b65\u6027\u65b9\u9762\uff0cKnife4j\u4f1a\u81ea\u52a8\u5728\u5f00\u53d1\u6587\u6863\u4e2d\u66f4\u65b0\u4ee3\u7801\u903b\u8f91\uff0c\u5f88\u65b9\u4fbf\u6211\u4eec\u8fdb\u884c\u4e34\u65f6\u5feb\u901f\u7684\u5f00\u53d1\u6d4b\u8bd5\u3002<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\u800cSwagger\u4e5f\u6709\u540c\u6837\u7684\u529f\u80fd\uff0c\u53ef\u4ee5\u8fd9\u4e48\u8bf4Knife4j\u5176\u5b9e\u662fSwagger\u7684Plus\u7248\u672c\uff0c\u800c\u6211\u4eec\u66f4\u52a0\u503e\u5411\u4e8e\u4f7f\u7528Knife4j\u7684\u539f\u56e0\u662f\u5176UI\u754c\u9762\u66f4\u52a0\u7b26\u5408\u4eba\u7c7b\u5ba1\u7f8e\u8fd9\u4e00\u5757<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Knife4j\u4f7f\u7528\u6d41\u7a0b<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">\u6709\u4e24\u79cd\u65b9\u5f0f\uff0c\u7b2c\u4e00\u79cd\u662f\u5199\u597d\u914d\u7f6e\u7c7b\uff0c\u5229\u7528\u6ce8\u91ca\u542f\u52a8\u6ce8\u91ca\uff0c\u4e4b\u540e\u5728\u9879\u76ee\u5f00\u542f\u7684\u65f6\u5019\u5c31\u4f1a\u81ea\u52a8\u626b\u63cf\u6307\u5b9a\u5305\u5185\u7684@RequestMapping,@RequestController,@GetMapping@PostMapping\u8fd9\u4e9b\u6620\u5c04\u6ce8\u91ca\u548c\u65b9\u6cd5\u53c2\u6570\uff0c\u6839\u636e\u6620\u5c04\u6ce8\u91ca\u6765\u81ea\u52a8\u62fc\u63a5\u597d\u5f00\u53d1\u6587\u6863\u9700\u8981\u7684\u8bf7\u6c42URL\u5730\u5740\u548c\u8bf7\u6c42\u53c2\u6570\u3002\u5982\u679c\u60f3\u8981\u5f80\u5f00\u53d1\u6587\u6863\u91cc\u9762\u6dfb\u52a0\u66f4\u591a\u7684\u6ce8\u91ca\u65b9\u4fbf\u9605\u8bfb\u7684\u8bdd\uff0c\u4e0b\u4e00\u6807\u9898\u7684\u5e38\u7528\u6ce8\u91ca\u4f1a\u63d0\u5230\uff0c\u4ee5\u4e0b\u662f\u7b80\u6613\u7684Knife4j\u642d\u5efa\u3002<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/\/\u521b\u5efa\u597d\u914d\u7f6e\u7c7b\n@Configuration\n@EnableSwagger2  \/\/ \u542f\u7528Swagger2\uff08Knife4j\u57fa\u4e8e\u6b64\uff09\npublic class SwaggerConfig {\n\n    \/\/ \u914d\u7f6eDocket\u6838\u5fc3Bean\n    @Bean\n    public Docket createRestApi() {\n        return new Docket(DocumentationType.SWAGGER_2)\n                .apiInfo(apiInfo())\n                .select()\n                \/\/ \u6307\u5b9aController\u626b\u63cf\u5305\u8def\u5f84\n                .apis(RequestHandlerSelectors.basePackage(\"com.example.controller\")) \n                .paths(PathSelectors.any())\n                .build();\n    }\n\n    \/\/ \u914d\u7f6eAPI\u57fa\u672c\u4fe1\u606f\n    private ApiInfo apiInfo() {\n        return new ApiInfoBuilder()\n                .title(\"API\u63a5\u53e3\u6587\u6863\")  \/\/ \u6587\u6863\u6807\u9898\n                .description(\"\u7cfb\u7edf\u5f00\u53d1\u63a5\u53e3\u6587\u6863\")  \/\/ \u8be6\u7ec6\u63cf\u8ff0\n                .version(\"1.0.0\")  \/\/ \u6587\u6863\u7248\u672c\n                .contact(new Contact(\"\u5f20\u4e09\", \"https:\/\/zhangsan.com\", \"zhangsan@example.com\")) \n                .build();\n    }\n} <\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\u4e4b\u540e\u7684\u5185\u5bb9\u5c31\u5f88\u7b80\u5355\u4e86\uff0c\u8be6\u60c5\u89c1\u4e0b\u4e00\u6807\u9898\u3002\u8fd8\u6709\u7b2c\u4e8c\u79cd\u65b9\u6cd5\uff0c\u90a3\u5c31\u662f\u4f7f\u7528\u914d\u7f6e\u6587\u4ef6\u6765\u4ee3\u66ff\u914d\u7f6e\u7c7b\uff0c\u5927\u4f53\u5185\u5bb9\u90fd\u5dee\u4e0d\u591a<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>knife4j:\n  enable: true \/\/\u5f00\u542fKnife4j\n  setting:\n    language: zh-CN\/\/\u5f00\u542f\u4e2d\u6587\n  openapi:\n    title: \u5f00\u53d1\u9879\u76ee\u540d\u79f0\n    description: \u63cf\u8ff0\u5f00\u53d1\u9879\u76ee\u5177\u4f53\u5185\u5bb9\n    version: 1.0.0\n    concat:\n    license: Apache License 2.0\n    license-url: https:\/\/github.com\/itwanger\/paicoding\/blob\/main\/License\n    email: bangzewu@126.com\n    group:\/\/\n      admin:\n        group-name: \u540e\u53f0\u63a5\u53e3\u5206\u7ec4\n        api-rule: package\/\/\u626b\u63cf\u54ea\u4e9b\u5185\u5bb9\n        api-rule-resources:\/\/\u5177\u4f53\u662f\u54ea\u4e2a\n          - com.github.paicoding.forum.web.admin\n      front:\n        group-name: \u524d\u53f0\u63a5\u53e3\u5206\u7ec4\n        api-rule: package\n        api-rule-resources:\n          - com.github.paicoding.forum.web.front<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\u6211\u66f4\u503e\u5411\u4e8e\u63a8\u8350\u7b2c\u4e8c\u79cd\uff0c\u8fd9\u6837\u4e0d\u9700\u8981\u663e\u793a\u7684\u5199\u51faDokcer\u7ec4\u4ef6\uff0c\u5e76\u4e14\u914d\u7f6e\u6587\u4ef6\u7684\u5f62\u5f0f\u53ef\u4ee5\u8bf4\u5f88\u4fbf\u4e8e\u4fee\u6539\u4e86<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Knife4j\u7684\u5e38\u7528\u6ce8\u91ca<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">\u4e0a\u6587\u63d0\u5230Knife4j\u80fd\u591f\u81ea\u52a8\u751f\u6210\u5f00\u53d1\u6587\u6863\u662f\u56e0\u4e3a\u626b\u63cf\u4e86\u5bf9\u5e94\u7684\u6ce8\u91ca\uff0c\u7ecf\u8fc7\u89e3\u6790\u5f97\u5230\u5bf9\u5e94\u5185\u5bb9\uff0c\u5176\u5b9e\u8fd8\u6709\u66f4\u591a\u7684\u6ce8\u91ca\u4fbf\u4e8e\u6211\u4eec\u5b8c\u6210\u5f00\u53d1\u6587\u6863\u7684\u8be6\u5907\uff0c\u5206\u522b\u662f<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>@ApiOperation(name=&#8221;\u8be5\u63a5\u53e3\u7684\u540d\u79f0&#8221;\uff0cnotes=\u201c\u8be5\u63a5\u53e3\u7684\u8be6\u7ec6\u63cf\u8ff0\u201d\uff0ctags) \u52a0\u5728\u7c7b\u4e0a<\/li>\n\n\n\n<li>@Operation(summary=&#8221;\u8be5\u63a5\u53e3\u529f\u80fd\u7684\u540d\u79f0&#8221;\uff0cdescription=\u201c\u8be5\u63a5\u53e3\u529f\u80fd\u7684\u8be6\u7ec6\u4fe1\u606f\u201d) \u52a0\u5728\u7c7b\u4e2d\u7684\u65b9\u6cd5\u4e0a<\/li>\n\n\n\n<li>@Parameter(<code>required<\/code>: \u662f\u5426\u5fc5\u586b,<code>description<\/code>: \u53c2\u6570\u63cf\u8ff0) \u6dfb\u52a0\u5728\u53c2\u6570\u5217\u8868\u4e2d<\/li>\n\n\n\n<li><code>@Schema<\/code>(description:\u63cf\u8ff0\u5c5e\u6027\u662f\u4ec0\u4e48)\u5e94\u7528\u4e8eDTO\/VO\u7c7b\u7684\u5c5e\u6027\u4e0a\uff0c\u63cf\u8ff0\u6570\u636e\u6a21\u578b\u7684\u5b57\u6bb5\u3002\u00a0\u8fd9\u662f\u8ba9\u6587\u6863\u6e05\u6670\u5c55\u793a\u6570\u636e\u7ed3\u6784\u7684\u5173\u952e<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u5728\u540e\u7aef\u5f00\u53d1\u8fc7\u7a0b\u4e2d\u5f53\u6211\u4eec\u5b9e\u73b0\u63a5\u53e3\u529f\u80fd\u7684\u65f6\u5019\uff0c\u5982\u679c\u8981\u6d4b\u8bd5\u7684\u8bdd\uff0c\u4e0d\u4ec5\u8981\u62fc\u63a5URL\u5730\u5740\uff0c\u9891\u7e41\u7684\u6d4b\u8bd5\u8fc7\u7a0b\u4f1a\u4e0d\u65ad\u62fc\u63a5URL [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":129,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[7,1],"tags":[],"class_list":["post-125","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-ai","category-learn"],"_links":{"self":[{"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/posts\/125","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/comments?post=125"}],"version-history":[{"count":3,"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/posts\/125\/revisions"}],"predecessor-version":[{"id":128,"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/posts\/125\/revisions\/128"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/media\/129"}],"wp:attachment":[{"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/media?parent=125"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/categories?post=125"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lsuccess.xyz\/index.php\/wp-json\/wp\/v2\/tags?post=125"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}