{"id":703,"date":"2023-11-11T09:01:01","date_gmt":"2023-11-11T01:01:01","guid":{"rendered":""},"modified":"2023-11-11T09:01:01","modified_gmt":"2023-11-11T01:01:01","slug":"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863","status":"publish","type":"post","link":"https:\/\/mushiming.com\/703.html","title":{"rendered":"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863"},"content":{"rendered":"<p>\u524d\u8a00\uff0c\u4f17\u6240\u5468\u77e5\uff0c\u540e\u7aef\u7684\u63a5\u53e3\u6587\u6863\u4e00\u822c\u4f7f\u7528 swagger\/openapi\uff0c\u800c\u5176\u4ed6\u7684\u4e00\u822c\u63a5\u53e3\u6587\u6863\u4e5f\u57fa\u672c\u662f\u4f7f\u7528 openapi \u6765\u8fdb\u884c\u89e3\u6790\u7684\u3002\u4f8b\u5982 redoc(20.8k star) \u548c knife4j(3.5k star) \u7b49.<\/p>\n<p>\u4f5c\u4e3a\u4e00\u4e2a\u901a\u7528\u7684\u89e3\u51b3\u65b9\u6848\uff0c\u524d\u7aef\u793e\u533a\u81ea\u7136\u4e5f\u6709\u5bf9\u5e94\u7684\u5b9e\u73b0\u3002<\/p>\n<h2 data-id=\"heading-0\">\u5982\u4f55\u5b9e\u73b0 swagger \u6587\u6863\u754c\u9762<\/h2>\n<p>swagger-ui-express \u662f\u4e00\u4e2a express \u63d2\u4ef6\uff0c\u53ef\u4ee5\u5728 express \u4e2d\u5b9e\u73b0 swagger-ui\u3002\u7136\u540e\u4f20\u5165 openapi \u6765\u6e32\u67d3\u63a5\u53e3\u6587\u6863\u3002<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-js\" lang=\"js\"><span class=\"hljs-keyword\">const<\/span> express = <span class=\"hljs-built_in\">require<\/span>(<span class=\"hljs-string\">\"express\"<\/span>);\n<span class=\"hljs-keyword\">const<\/span> app = <span class=\"hljs-title function_\">express<\/span>();\n<span class=\"hljs-keyword\">const<\/span> swaggerUi = <span class=\"hljs-built_in\">require<\/span>(<span class=\"hljs-string\">\"swagger-ui-express\"<\/span>);\n<span class=\"hljs-keyword\">const<\/span> swaggerDocument = <span class=\"hljs-built_in\">require<\/span>(<span class=\"hljs-string\">\".\/swagger.json\"<\/span>);\n\n<span class=\"hljs-keyword\">var<\/span> options = {\n  <span class=\"hljs-attr\">explorer<\/span>: <span class=\"hljs-literal\">true<\/span>,\n};\n\napp.<span class=\"hljs-title function_\">use<\/span>(\n  <span class=\"hljs-string\">\"\/api-docs\"<\/span>,\n  swaggerUi.<span class=\"hljs-property\">serve<\/span>,\n  swaggerUi.<span class=\"hljs-title function_\">setup<\/span>(swaggerDocument, options)\n);\n<\/code><\/pre>\n<p>\u4ece\u4e0a\u9762\u7684\u793a\u4f8b\u53ef\u4ee5\u770b\u5230 swagger.json \u5373\u4e3a\u63a5\u53e3\u6587\u6863\u7684\u63cf\u8ff0\u6570\u636e\u3002\u5728\u8fd9\u79cd\u60c5\u51b5\u4e0b\u6211\u4eec\u9700\u8981\u51c6\u5907\u5df2\u7ecf\u6709\u7684 json \u6570\u636e\u65b9\u53ef\u663e\u793a\u6587\u6863\u3002<\/p>\n<h2 data-id=\"heading-1\">\u5982\u4f55\u751f\u6210\u6587\u6863\u63cf\u8ff0\u6570\u636e<\/h2>\n<p>\u6211\u4eec\u53ef\u4ee5\u5b89\u6392 swagger-jsdoc \u8fd9\u4e2a\u5e93\uff0c\u6765\u5b9e\u73b0\u5728\u4ee3\u7801\u4e2d\u5199\u63a5\u53e3\u6ce8\u91ca\uff0c\u5373\u53ef\u751f\u6210\u6587\u6863\u6570\u636e\u3002<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-js\" lang=\"js\"><span class=\"hljs-comment\">\/\/ Initialize swagger-jsdoc -&gt; returns validated swagger spec in json format<\/span>\n<span class=\"hljs-keyword\">const<\/span> swaggerSpec = <span class=\"hljs-title function_\">swaggerJSDoc<\/span>(options);\n\napp.<span class=\"hljs-title function_\">use<\/span>(<span class=\"hljs-string\">\"\/api-docs\"<\/span>, swaggerUi.<span class=\"hljs-property\">serve<\/span>, swaggerUi.<span class=\"hljs-title function_\">setup<\/span>(swaggerSpec));\n<\/code><\/pre>\n<p>\u6ce8\u91ca\u793a\u4f8b\uff1a<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-js\" lang=\"js\"><span class=\"hljs-comment\">\/** * <span class=\"hljs-doctag\">@openapi<\/span> * \/: * get: * description: Welcome to swagger-jsdoc! * responses: * 200: * description: Returns a mysterious string. *\/<\/span>\napp.<span class=\"hljs-title function_\">get<\/span>(<span class=\"hljs-string\">\"\/\"<\/span>, <span class=\"hljs-function\">(<span class=\"hljs-params\">req, res<\/span>) =&gt;<\/span> {\n  res.<span class=\"hljs-title function_\">send<\/span>(<span class=\"hljs-string\">\"Hello World!\"<\/span>);\n});\n<\/code><\/pre>\n<h2 data-id=\"heading-2\">\u6587\u6863\u4e0d\u60f3\u5199\uff0c\u6ce8\u91ca\u4e0d\u60f3\u5199\uff0c\u5c31\u60f3\u751f\u6210\u63a5\u53e3\u6587\u6863<\/h2>\n<p>\u5728\u4e4b\u524d\u7684\u793a\u4f8b\u4e2d\uff0c\u867d\u7136\u6211\u4eec\u53ef\u4ee5\u901a\u8fc7\u5199 jsdoc \u5f62\u5f0f\u7684\u6ce8\u91ca\u6765\u5b9e\u73b0\u4e5f\u5199\u63a5\u53e3\u6587\u6863\u3002\u4f46\u95ee\u9898\u662f\uff0c\u6211\u90fd\u80fd\u5728\u6ce8\u91ca\u91cc\u628a\u6587\u6863\u5199\u6e05\u695a\u4e86\uff0c\u5c31\u4e0d\u53eb\u201c\u751f\u6210\u6587\u6863\u201d\u4e86\uff0c\u800c\u53eb\u6536\u96c6\u6587\u6863\u7247\u6bb5\uff0c\u800c\u4e14\u5728\u4ee3\u7801\u91cc\u5199\u6587\u6863\uff0c\u4f3c\u4e4e\u4e5f\u4e0d\u592a\u4f18\u96c5\u3002<\/p>\n<p>\u8981\u5b9e\u73b0\u6ce8\u91ca\u5199\u4e0d\u60f3\u5199\uff0c\u5c31\u80fd\u5b9e\u73b0\u63a5\u53e3\u6587\u6863\u7684\u751f\u6210\uff0c\u6211\u4eec\u9996\u5148\u8981\u8ba9\u67d0\u4e2a\u5de5\u5177\u80fd\u7406\u89e3\u6211\u4eec\u4ee3\u7801\u7684\u610f\u56fe\u3002\u5982\u4f55\u7406\u89e3\uff1f<\/p>\n<ul>\n<li>\u65b9\u6cd5 1 \u901a\u8fc7\u4eba\u5de5\u667a\u80fd\u53bb\u7406\u89e3\u4ee3\u7801\u610f\u56fe\u7136\u540e\u751f\u6210\u6587\u6863<\/li>\n<li>\u65b9\u6cd5 2 \u901a\u8fc7\u4ee3\u7801\u94a9\u5b50\u6216\u57cb\u70b9\u83b7\u53d6\u610f\u56fe\u751f\u6210\u6587\u6863<\/li>\n<\/ul>\n<p>\u5f88\u663e\u7136\uff0c\u65b9\u6cd5 1 \u4e0d\u5728\u6211\u4eec\u7684\u5b9e\u73b0\u8303\u7574\uff0c\u56e0\u4e3a\u5b83\u6d89\u53ca\u5927\u6a21\u578b\u3001\u6570\u636e\u5b89\u5168\u3001\u672c\u5730\u5316\u7b49\u5404\u79cd\u95ee\u9898\u3002\u800c\u65b9\u6cd5 2 \u5219\u662f\u6211\u4eec\u80fd\u53bb\u7814\u7a76\u7684\u65b9\u6848\uff0c\u4f8b\u5982\u6211\u4eec\u4f7f\u7528 vue \u5f00\u53d1\u9879\u76ee\u65f6\uff0cvue-devtool \u63d2\u4ef6\u5c31\u80fd\u770b\u5230 vue \u76f8\u5173\u7684\u72b6\u6001\uff0c\u8fd9\u5c31\u662f\u5728 vue \u7684\u5b9e\u73b0\u4e2d\u6709\u4e3a\u63d2\u4ef6\u5f00\u653e\u83b7\u53d6\u72b6\u6001\u7684\u63a5\u53e3\u3002\u5982\u679c\u6ca1\u6709\u5f00\u653e\uff0c\u4e5f\u53ef\u4ee5\u901a\u8fc7\u62e6\u622a\u3001\u4ee3\u7406\u7b49\u65b9\u6cd5\u83b7\u53d6\u8fd0\u884c\u72b6\u6001\u3002<\/p>\n<h2 data-id=\"heading-3\">\u5206\u6790\u63a5\u53e3\u610f\u56fe<\/h2>\n<p>\u5bf9\u4e8e\u539f\u751f\u7684 express \u4ea7\u751f\u7684\u63a5\u53e3\uff0c\u6211\u4eec\u53ef\u4ee5\u901a\u8fc7 <code>app.routes<\/code> <code>app._router.stack<\/code> <code>express.Router()<\/code> <code>router.stack<\/code> \u7b49 api \u83b7\u53d6\u5230\u5f53\u524d\u6240\u4f7f\u7528\u7684\u63a5\u53e3\u3002\u4f46\u6211\u4eec\u8fd9\u91cc\u4f7f\u7528 mockm\uff0c\u63a5\u53e3\u662f\u76f4\u63a5\u58f0\u660e\u5728\u5bf9\u8c61\u4e2d\u7684\uff0c\u5c31\u66f4\u7b80\u5355\u4e86\u8bb8\u591a\u3002<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-js\" lang=\"js\"><span class=\"hljs-attr\">api<\/span>: {\n  <span class=\"hljs-string\">\"\/a\"<\/span>: <span class=\"hljs-number\">111<\/span>,\n  <span class=\"hljs-string\">\"\/b\"<\/span>: <span class=\"hljs-number\">222<\/span>,\n  <span class=\"hljs-string\">'get \/name'<\/span>: <span class=\"hljs-string\">`\u5f20\u4e09`<\/span>,\n  <span class=\"hljs-string\">'\/status\/:code'<\/span> (req, res) {\n    res.<span class=\"hljs-title function_\">json<\/span>({<span class=\"hljs-attr\">statusCode<\/span>: req.<span class=\"hljs-property\">params<\/span>.<span class=\"hljs-property\">code<\/span>})\n  },\n},\n<\/code><\/pre>\n<p>\u89c2\u5bdf\u4e0a\u9762\u7684 api \u5bf9\u8c61\uff0c\u4f8b\u5982 <code>\"\/a\": 111<\/code> \u5b9e\u73b0\u7684\u63a5\u53e3\u662f\u65e0\u8bba\u901a\u8fc7\u4ec0\u4e48\u65b9\u6cd5\u8bf7\u6c42 \/a \u8fd9\u4e2a\u63a5\u53e3\uff0c\u90fd\u8fd4\u56de\u6570\u5b57 111\uff0c\u800c <code>'get \/name': '\u5f20\u4e09',<\/code> \u5219\u662f\u901a\u8fc7 get \u8bf7\u6c42 \/name \u65f6\u8fd4\u56de\u5b57\u7b26\u4e32 <code>\u5f20\u4e09<\/code>\u3002<\/p>\n<p>\u4ee5\u4e0b\u662f\u8f6c\u6362 api \u4e3a openApi json \u7684\u5b9e\u73b0\uff1a<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-js\" lang=\"js\"><span class=\"hljs-title function_\">toOpenApi<\/span>(<span class=\"hljs-params\">serverRouterList<\/span>) {\n  <span class=\"hljs-keyword\">const<\/span> mapObj = {\n    <span class=\"hljs-title function_\">all<\/span>(<span class=\"hljs-params\">item<\/span>) {\n      <span class=\"hljs-keyword\">return<\/span> [\n        <span class=\"hljs-string\">`delete`<\/span>,\n        <span class=\"hljs-string\">`get`<\/span>,\n        <span class=\"hljs-string\">`patch`<\/span>,\n        <span class=\"hljs-string\">`post`<\/span>,\n        <span class=\"hljs-string\">`put`<\/span>,\n      ].<span class=\"hljs-title function_\">map<\/span>(<span class=\"hljs-function\"><span class=\"hljs-params\">method<\/span> =&gt;<\/span> {\n        <span class=\"hljs-keyword\">return<\/span> {\n          ...item,\n          method,\n          <span class=\"hljs-attr\">tags<\/span>: item.<span class=\"hljs-property\">tags<\/span> || [<span class=\"hljs-string\">`all-method`<\/span>],\n        }\n      })\n    },\n  }\n  serverRouterList = serverRouterList.<span class=\"hljs-title function_\">map<\/span>(<span class=\"hljs-function\"><span class=\"hljs-params\">item<\/span> =&gt;<\/span> {\n    <span class=\"hljs-keyword\">const<\/span> fn = mapObj[item.<span class=\"hljs-property\">method<\/span>]\n    <span class=\"hljs-keyword\">return<\/span> fn ? <span class=\"hljs-title function_\">fn<\/span>(item) : [item]\n  }).<span class=\"hljs-title function_\">flat<\/span>()\n  <span class=\"hljs-keyword\">return<\/span> serverRouterList\n}\n<\/code><\/pre>\n<p><img decoding=\"async\" src=\"https:\/\/p6-juejin.byteimg.com\/tos-cn-i-k3u1fbpfcp\/516f57a4e2194b088386434c37982447~tplv-k3u1fbpfcp-zoom-in-crop-mark:1512:0:0:0.awebp?\" =\"image.png\" loading=\"lazy\" alt=\"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863 (https:\/\/mushiming.com\/) \u6280\u672f\u535a\u5ba2 \u7b2c1\u5f20\" title=\"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863 \u6280\u672f\u535a\u5ba2 \u7b2c1\u5f20-\u7a46\u4e16\u660e\u535a\u5ba2\" ><\/p>\n<p>serverRouterList \u662f\u683c\u5f0f\u5316 api \u540e\u9762\u7684\u6570\u636e\uff0c\u5305\u542b method route action alias \u7b49\uff0c\u5176\u4e2d\u8981\u751f\u6210\u63a5\u53e3\u6587\u6863\uff0c\u53ea\u9700\u8981\u6709 method route \u5c31\u8db3\u591f\u4e86\u3002<\/p>\n<p>\u4e00\u4e2a\u53ea\u5305\u542b\u6b64\u63a5\u53e3\u7684 openApi json \u751f\u6210\u540e\u5982\u4e0b\uff1a<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-json\" lang=\"json\"><span class=\"hljs-punctuation\">{<\/span>\n  <span class=\"hljs-attr\">\"openapi\"<\/span><span class=\"hljs-punctuation\">:<\/span> <span class=\"hljs-string\">\"3.0.0\"<\/span><span class=\"hljs-punctuation\">,<\/span>\n  <span class=\"hljs-attr\">\"servers\"<\/span><span class=\"hljs-punctuation\">:<\/span> <span class=\"hljs-punctuation\">[<\/span>\n    <span class=\"hljs-punctuation\">{<\/span>\n      <span class=\"hljs-attr\">\"url\"<\/span><span class=\"hljs-punctuation\">:<\/span> <span class=\"hljs-string\">\"\/\"<\/span>\n    <span class=\"hljs-punctuation\">}<\/span>\n  <span class=\"hljs-punctuation\">]<\/span><span class=\"hljs-punctuation\">,<\/span>\n  <span class=\"hljs-attr\">\"tags\"<\/span><span class=\"hljs-punctuation\">:<\/span> <span class=\"hljs-punctuation\">[<\/span><span class=\"hljs-punctuation\">]<\/span><span class=\"hljs-punctuation\">,<\/span>\n  <span class=\"hljs-attr\">\"paths\"<\/span><span class=\"hljs-punctuation\">:<\/span> <span class=\"hljs-punctuation\">{<\/span>\n    <span class=\"hljs-attr\">\"\/a\"<\/span><span class=\"hljs-punctuation\">:<\/span> <span class=\"hljs-punctuation\">{<\/span>\n      <span class=\"hljs-attr\">\"get\"<\/span><span class=\"hljs-punctuation\">:<\/span> <span class=\"hljs-punctuation\">{<\/span>\n        <span class=\"hljs-attr\">\"parameters\"<\/span><span class=\"hljs-punctuation\">:<\/span> <span class=\"hljs-punctuation\">[<\/span><span class=\"hljs-punctuation\">]<\/span><span class=\"hljs-punctuation\">,<\/span>\n        <span class=\"hljs-attr\">\"responses\"<\/span><span class=\"hljs-punctuation\">:<\/span> <span class=\"hljs-punctuation\">{<\/span><span class=\"hljs-punctuation\">}<\/span>\n      <span class=\"hljs-punctuation\">}<\/span>\n    <span class=\"hljs-punctuation\">}<\/span>\n  <span class=\"hljs-punctuation\">}<\/span>\n<span class=\"hljs-punctuation\">}<\/span>\n<\/code><\/pre>\n<p>\u770b\u8d77\u6765\u662f\u7b80\u5355\u5427\uff1f<\/p>\n<p>\u7136\u540e\u628a\u5b83\u4ea4\u7ed9 swagger-ui \u5373\u53ef\u6e32\u67d3\u51fa\u6587\u6863\uff0c\u5c55\u73b0\u548c\u4f7f\u7528\u90fd\u6ca1\u6709\u95ee\u9898\uff1a<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/p3-juejin.byteimg.com\/tos-cn-i-k3u1fbpfcp\/b7c466f7a51a444c9b2191daaac40764~tplv-k3u1fbpfcp-zoom-in-crop-mark:1512:0:0:0.awebp?\" =\"2023-08-16-11-54-08.png\" loading=\"lazy\" alt=\"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863 (https:\/\/mushiming.com\/) \u6280\u672f\u535a\u5ba2 \u7b2c2\u5f20\" title=\"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863 \u6280\u672f\u535a\u5ba2 \u7b2c2\u5f20-\u7a46\u4e16\u660e\u535a\u5ba2\" ><\/p>\n<h2 data-id=\"heading-4\">\u5982\u4f55\u4e3a\u63a5\u53e3\u5206\u7ec4\u3001\u6dfb\u52a0\u5b57\u6bb5\u8bf4\u660e\u3001\u6570\u636e\u9a8c\u8bc1\u7b49\u529f\u80fd\uff1f<\/h2>\n<p>\u63a5\u53e3\u5206\u7ec4\u6bd4\u8f83\u7b80\u5355\uff0c\u76f4\u63a5\u4e3a\u63a5\u53e3\u8bbe\u7f6e\u6807\u7b7e\u5c31\u884c\u3002\u7531\u4e8e\u5728 mockm \u4e2d\u53ef\u4ee5\u76f4\u63a5\u5199\u5b57\u9762\u91cf\u5373\u53ef\u751f\u6210 api\uff0c\u4f46\u6211\u4eec\u8981\u4e3a api \u6dfb\u52a0\u989d\u5916\u8bf4\u660e\u7684\u65f6\u5019\uff0c\u5c31\u4e0d\u80fd\u7b80\u5355\u7684\u4f7f\u7528\u5b57\u9762\u91cf\u4e86\u3002<\/p>\n<p>\u4e3a\u4e86\u517c\u5bb9 mockm \u7684\u5df2\u6709\u5b9e\u73b0\uff0c\u6211\u4eec\u6269\u5c55\u4e00\u4e2a\u53eb side \u7684\u51fd\u6570\uff0c\u7528\u4e8e\u6536\u96c6\u989d\u5916\u4fe1\u606f\u548c\u8fd4\u56de\u5b57\u9762\u91cf\u3002<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-js\" lang=\"js\">\n<span class=\"hljs-string\">\"post \/api\/login\"<\/span>: <span class=\"hljs-title function_\">side<\/span>({\n  <span class=\"hljs-attr\">tags<\/span>: [<span class=\"hljs-string\">`admin`<\/span>],\n  <span class=\"hljs-attr\">summary<\/span>: <span class=\"hljs-string\">`\u6839\u636e\u7528\u6237\u540d\u83b7\u53d6 token`<\/span>,\n  <span class=\"hljs-attr\">schema<\/span>: {\n    <span class=\"hljs-attr\">body<\/span>: joi.<span class=\"hljs-title function_\">object<\/span>({\n      <span class=\"hljs-attr\">username<\/span>: joi.<span class=\"hljs-title function_\">string<\/span>()\n        .<span class=\"hljs-title function_\">default<\/span>(<span class=\"hljs-string\">`\u674e\u857e`<\/span>)\n        .required()\n        .<span class=\"hljs-title function_\">description<\/span>(<span class=\"hljs-string\">`\u7528\u6237\u540d`<\/span>),\n    }).<span class=\"hljs-title function_\">description<\/span>(<span class=\"hljs-string\">`\u7528\u6237\u4fe1\u606f`<\/span>),\n  },\n  action (req, res) {\n    <span class=\"hljs-keyword\">const<\/span> { username } = req.<span class=\"hljs-property\">body<\/span>\n    res.<span class=\"hljs-title function_\">json<\/span>({\n      <span class=\"hljs-attr\">status<\/span>: <span class=\"hljs-number\">200<\/span>,\n      <span class=\"hljs-attr\">message<\/span>: <span class=\"hljs-string\">`\u6b22\u8fce <span class=\"hljs-subst\">${username}<\/span>, \u767b\u5f55\u6210\u529f`<\/span>,\n      <span class=\"hljs-attr\">token<\/span>: <span class=\"hljs-string\">`tokentoken`<\/span>,\n    });\n  }\n}),\n<\/code><\/pre>\n<p>\u53ef\u4ee5\u770b\u5230\uff0c\u6211\u4eec\u5728 side \u51fd\u6570\u4e2d\uff0c\u4e3a api \u8fdb\u884c\u4e86\u5206\u7ec4\uff0c\u5e76\u4e14\u4e3a api \u6dfb\u52a0\u4e86\u63cf\u8ff0\uff0c\u7136\u540e\u4e3a api \u7684\u6bcf\u4e2a\u5b57\u6bb5\u6dfb\u52a0\u4e86\u8bf4\u660e\uff0c\u662f\u5426\u5fc5\u586b\uff0c\u6570\u5b57\u7c7b\u578b\u662f\u4ec0\u4e48\u7b49\u3002<\/p>\n<p>\u8fd9\u65f6\u5019\u53ef\u80fd\u6709\u4e00\u4e2a\u7591\u95ee\uff0c\u5728\u524d\u9762\u63d0\u5230\u4e86\u4f7f\u7528\u6ce8\u91ca\u7f16\u5199\u63a5\u53e3\u6587\u6863\u4fe1\u606f\uff0c\u800c\u8fd9\u91cc\u5219\u662f\u4f7f\u7528\u4ee3\u7801\u7f16\u5199\u63a5\u53e3\u4fe1\u606f\uff0c\u4ed6\u4eec\u4e4b\u524d\u7684\u533a\u522b\u5728\u54ea\u91cc\uff1f<\/p>\n<ul>\n<li>\u533a\u522b 1 \u4f7f\u7528\u6ce8\u91ca\u7f16\u5199\u65f6\u6ca1\u6709\u8bed\u6cd5\u63d0\u793a\u3001\u4ee3\u7801\u5b8c\u6210\u3001\u4ee3\u7801\u9ad8\u4eae\u7b49\u529f\u80fd\uff0c\u5341\u5206\u4e0d\u65b9\u4fbf<\/li>\n<li>\u533a\u522b 2 \u4f7f\u7528\u6ce8\u91ca\u7f16\u5199\u65f6\uff0c\u5b9e\u9645\u4e0a\u662f\u5728\u5199\u539f\u59cb openapi yaml \u683c\u5f0f\u7684\u6570\u636e\uff0c\u8fd9\u8981\u6c42\u4f60\u5bf9 openapi \u89c4\u8303\u6709\u76f8\u5f53\u7684\u4e86\u89e3\u548c\u719f\u6089<\/li>\n<li>\u533a\u522b 3 \u4f7f\u7528\u4ee3\u7801\u7f16\u5199\u65f6\uff0c\u987a\u4fbf\u53ef\u4ee5\u5b8c\u6210\u4e1a\u52a1\u4e0a\u7684\u5176\u4ed6\u529f\u80fd\uff0c\u800c\u6ce8\u91ca\u548c\u4e1a\u52a1\u662f\u5272\u88c2\u7684\uff0c\u6211\u4eec\u90fd\u77e5\u9053\u4e1a\u52a1\u66f4\u65b0\u4f46\u6ce8\u91ca\u6ca1\u66f4\u65b0\u7684\u90a3\u79cd\u5669\u68a6<\/li>\n<\/ul>\n<p>\u89c2\u5bdf\u4e0a\u9762\u7684\u4ee3\u7801\uff0c\u6211\u4eec\u4f7f\u7528 joi \u6765\u8fdb\u884c\u6570\u636e\u63cf\u8ff0\uff0c\u4e0e\u6b64\u540c\u65f6 joi \u4e5f\u53ef\u4ee5\u4e3a\u6211\u4eec\u5b9e\u73b0\u6570\u636e\u7684\u6821\u9a8c\u3002<\/p>\n<p>\u4ee5\u4e0b\u662f\u6587\u6863\u751f\u6210\u6548\u679c\uff0c\u53ef\u4ee5\u770b\u5230\u6570\u636e\u63cf\u8ff0\u3001\u9ed8\u8ba4\u503c(\u793a\u4f8b\u503c)\u3001\u7c7b\u578b\u3001\u662f\u5426\u5fc5\u586b\u7b49\u90fd\u53ef\u4ee5\u6b63\u5e38\u663e\u793a\uff1a<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/p3-juejin.byteimg.com\/tos-cn-i-k3u1fbpfcp\/7fad02846f38461d9142a7d016a94959~tplv-k3u1fbpfcp-zoom-in-crop-mark:1512:0:0:0.awebp?\" =\"2023-08-16-12-09-42.png\" loading=\"lazy\" alt=\"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863 (https:\/\/mushiming.com\/) \u6280\u672f\u535a\u5ba2 \u7b2c3\u5f20\" title=\"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863 \u6280\u672f\u535a\u5ba2 \u7b2c3\u5f20-\u7a46\u4e16\u660e\u535a\u5ba2\" ><\/p>\n<p>\u4ee5\u4e0b\u662f\u63a5\u53e3\u6821\u9a8c\u529f\u80fd\u7684\u6548\u679c\uff0c\u6211\u4eec\u5728\u63a5\u53e3\u4e2d\u58f0\u660e\u4e86 username \u4e3a string\uff0c\u4f46\u6211\u4eec\u5c1d\u8bd5\u4f20\u5165\u6570\u5b57 111\uff0c\u7ed3\u679c\u6309\u9884\u671f\u8fd0\u884c\uff0c\u81ea\u52a8\u63d0\u793a\u4e86\u54ea\u4e2a\u5b57\u6bb5\u9519\u8bef\u4e86\uff0c\u4e3a\u4ec0\u4e48\u9519\uff1a<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/p6-juejin.byteimg.com\/tos-cn-i-k3u1fbpfcp\/3ba06b5c52e948f6a1cfb992dfcf9b47~tplv-k3u1fbpfcp-zoom-in-crop-mark:1512:0:0:0.awebp?\" =\"2023-08-16-12-14-42.png\" loading=\"lazy\" alt=\"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863 (https:\/\/mushiming.com\/) \u6280\u672f\u535a\u5ba2 \u7b2c4\u5f20\" title=\"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863 \u6280\u672f\u535a\u5ba2 \u7b2c4\u5f20-\u7a46\u4e16\u660e\u535a\u5ba2\" ><\/p>\n<h2 data-id=\"heading-5\">\u529f\u80fd\u63d2\u4ef6\u5316<\/h2>\n<p>\u5bf9\u4e8e\u4f7f\u7528 mockm \u7684\u7fa4\u4f53\u4e2d\uff0c\u6709\u4e00\u4e9b\u670b\u53cb\u53ef\u80fd\u5e76\u4e0d\u60f3\u53bb\u771f\u7684\u7528\u5b83\u6765\u5b9e\u73b0 api \uff0c\u66f4\u522b\u8bf4\u8fd8\u8981\u4e3a api \u751f\u6210\u6587\u6863\uff0c\u6240\u4ee5\u628a\u6b64\u529f\u80fd\u62bd\u79bb\u4e3a\u63d2\u4ef6\uff0c\u5f53\u6709\u4e00\u5929 mockm \u7684\u529f\u80fd\u7e41\u590d\u65f6\uff0c\u53ef\u4ee5\u62c6\u5206\u4e3a\u63d2\u4ef6\u5305\u5355\u72ec\u5728\u5176\u4ed6\u4ed3\u5e93\u8fdb\u884c\u7ef4\u62a4\uff1a<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-js\" lang=\"js\"><span class=\"hljs-variable language_\">module<\/span>.<span class=\"hljs-property\">exports<\/span> = <span class=\"hljs-keyword\">async<\/span> (util) =&gt; {\n  <span class=\"hljs-keyword\">const<\/span> joi = <span class=\"hljs-keyword\">await<\/span> util.<span class=\"hljs-property\">tool<\/span>.<span class=\"hljs-property\">generate<\/span>.<span class=\"hljs-title function_\">initPackge<\/span>(<span class=\"hljs-string\">`joi`<\/span>);\n\n  <span class=\"hljs-keyword\">return<\/span> {\n    <span class=\"hljs-attr\">plugin<\/span>: [util.<span class=\"hljs-property\">plugin<\/span>.<span class=\"hljs-property\">validate<\/span>, util.<span class=\"hljs-property\">plugin<\/span>.<span class=\"hljs-property\">apiDoc<\/span>],\n  };\n};\n<\/code><\/pre>\n<h2 data-id=\"heading-6\">\u6e38\u4e50\u573a<\/h2>\n<h3 data-id=\"heading-7\">\u5b89\u88c5\u548c\u521d\u59cb\u5316 mockm<\/h3>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-sh\" lang=\"sh\">yarn add mockm\nnpx mm --config\n<\/code><\/pre>\n<h3 data-id=\"heading-8\">\u7f16\u5199\u63a5\u53e3<\/h3>\n<p>\u5728 mm.config.js \u4e2d\u5f55\u5165\u4ee5\u4e0b\u4fe1\u606f<\/p>\n<pre class=\"language-java prettyprint linenums\"><code class=\"hljs language-js\" lang=\"js\"><span class=\"hljs-variable language_\">module<\/span>.<span class=\"hljs-property\">exports<\/span> = <span class=\"hljs-keyword\">async<\/span> (util) =&gt; {\n  <span class=\"hljs-keyword\">const<\/span> joi = <span class=\"hljs-keyword\">await<\/span> util.<span class=\"hljs-property\">tool<\/span>.<span class=\"hljs-property\">generate<\/span>.<span class=\"hljs-title function_\">initPackge<\/span>(<span class=\"hljs-string\">`joi`<\/span>);\n\n  <span class=\"hljs-keyword\">return<\/span> {\n    <span class=\"hljs-attr\">plugin<\/span>: [util.<span class=\"hljs-property\">plugin<\/span>.<span class=\"hljs-property\">validate<\/span>, util.<span class=\"hljs-property\">plugin<\/span>.<span class=\"hljs-property\">apiDoc<\/span>],\n    <span class=\"hljs-attr\">api<\/span>: {\n      <span class=\"hljs-string\">\"post \/api\/login\"<\/span>: util.<span class=\"hljs-title function_\">side<\/span>({\n        <span class=\"hljs-attr\">tags<\/span>: [<span class=\"hljs-string\">`admin`<\/span>],\n        <span class=\"hljs-attr\">summary<\/span>: <span class=\"hljs-string\">`\u6839\u636e\u7528\u6237\u540d\u83b7\u53d6 token`<\/span>,\n        <span class=\"hljs-attr\">schema<\/span>: {\n          <span class=\"hljs-attr\">body<\/span>: joi\n            .<span class=\"hljs-title function_\">object<\/span>({\n              <span class=\"hljs-attr\">username<\/span>: joi\n                .<span class=\"hljs-title function_\">string<\/span>()\n                .<span class=\"hljs-title function_\">default<\/span>(<span class=\"hljs-string\">`\u674e\u857e`<\/span>)\n                .required()\n                .<span class=\"hljs-title function_\">description<\/span>(<span class=\"hljs-string\">`\u7528\u6237\u540d`<\/span>),\n            })\n            .<span class=\"hljs-title function_\">description<\/span>(<span class=\"hljs-string\">`\u7528\u6237\u4fe1\u606f`<\/span>),\n        },\n        <span class=\"hljs-keyword\">async<\/span> <span class=\"hljs-title function_\">action<\/span>(<span class=\"hljs-params\">req, res<\/span>) {\n          <span class=\"hljs-keyword\">const<\/span> { username } = req.<span class=\"hljs-property\">body<\/span>;\n          res.<span class=\"hljs-title function_\">json<\/span>({\n            <span class=\"hljs-attr\">status<\/span>: <span class=\"hljs-number\">200<\/span>,\n            <span class=\"hljs-attr\">message<\/span>: <span class=\"hljs-string\">`\u6b22\u8fce <span class=\"hljs-subst\">${username}<\/span>, \u767b\u5f55\u6210\u529f`<\/span>,\n            <span class=\"hljs-attr\">token<\/span>: <span class=\"hljs-string\">`tokentoken`<\/span>,\n          });\n        },\n      }),\n    },\n  };\n};\n<\/code><\/pre>\n<h3 data-id=\"heading-9\">\u67e5\u770b\u63a5\u53e3\u6587\u6863<\/h3>\n<p>\u6d4f\u89c8\u5668\u6253\u5f00 <code>http:\/\/127.0.0.1:9000\/doc<\/code> \u5373\u53ef<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/p3-juejin.byteimg.com\/tos-cn-i-k3u1fbpfcp\/efd852fe76c94df7a4f1eb70b1963260~tplv-k3u1fbpfcp-zoom-in-crop-mark:1512:0:0:0.awebp?\" =\"2023-08-16-12-44-10.png\" loading=\"lazy\" alt=\"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863 (https:\/\/mushiming.com\/) \u6280\u672f\u535a\u5ba2 \u7b2c5\u5f20\" title=\"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863 \u6280\u672f\u535a\u5ba2 \u7b2c5\u5f20-\u7a46\u4e16\u660e\u535a\u5ba2\" ><\/p>\n<p>\u4e00\u4e2a\u57fa\u4e8e express \u7684\u6846\u67b6\u3002\u5b83\u53ef\u4ee5\u5feb\u901f\u751f\u6210 api \u4ee5\u53ca\u521b\u9020\u6570\u636e\uff0c\u5f00\u7bb1\u5373\u7528\uff0c\u4fbf\u4e8e\u90e8\u7f72\u3002<\/p>\n<p>github \u5730\u5740\uff1agithub.com\/wll8\/mockm\uff0c\u6c42 star \u3002<\/p>\n","protected":false},"excerpt":{"rendered":"\u540e\u7aef\u95ee\uff1a\u4f5c\u4e3a\u524d\u7aef\u5982\u4f55\u5b9e\u73b0\u81ea\u52a8\u751f\u6210\u63a5\u53e3\u6587\u6863\u4f5c\u4e3a\u4e00\u4e2a\u524d\u7aef\uff0c\u4e86\u89e3\u63a5\u53e3\u6587\u6863\u7684\u751f\u6210\u65b9\u5f0f\uff0c\u4ee5\u53ca\u5b9e\u73b0\u4e00\u4e2a\u63a5\u53e3\u6587\u6863\u81ea\u52a8\u751f\u6210\u3001\u63a5\u53e3\u6570\u636e...","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\/703"}],"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=703"}],"version-history":[{"count":0,"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/posts\/703\/revisions"}],"wp:attachment":[{"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/media?parent=703"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/categories?post=703"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mushiming.com\/wp-json\/wp\/v2\/tags?post=703"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}