{"id":2170,"date":"2021-08-24T19:42:31","date_gmt":"2021-08-24T11:42:31","guid":{"rendered":"https:\/\/jimmyswebnote.com\/?p=2170"},"modified":"2021-08-24T20:06:36","modified_gmt":"2021-08-24T12:06:36","slug":"swagger-node-js-tutorial","status":"publish","type":"post","link":"https:\/\/jimmyswebnote.com\/swagger-node-js-tutorial\/","title":{"rendered":"\u524d\u7aef\u5de5\u7a0b\u5e2b\u9081\u5411\u5f8c\u7aef\u4e4b\u8def 8 \u2013 Swagger Node.js \u6559\u5b78\uff1a\u7528 Swagger \u81ea\u52d5\u7522\u751f API document"},"content":{"rendered":"\n<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_65 counter-hierarchy ez-toc-counter ez-toc-grey ez-toc-container-direction\">\n<p class=\"ez-toc-title\">Table of Contents<\/p>\n<label for=\"ez-toc-cssicon-toggle-item-66335222e90e2\" class=\"ez-toc-cssicon-toggle-label\"><span class=\"\"><span class=\"eztoc-hide\" style=\"display:none;\">Toggle<\/span><span class=\"ez-toc-icon-toggle-span\"><svg style=\"fill: #999;color:#999\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewBox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #999;color:#999\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewBox=\"0 0 24 24\" version=\"1.2\" baseProfile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/span><\/label><input type=\"checkbox\"  id=\"ez-toc-cssicon-toggle-item-66335222e90e2\"  aria-label=\"Toggle\" \/><nav><ul class='ez-toc-list ez-toc-list-level-1 ' ><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/jimmyswebnote.com\/swagger-node-js-tutorial\/#1_%E7%82%BA%E4%BB%80%E9%BA%BC%E9%9C%80%E8%A6%81_API_document\" title=\"1. \u70ba\u4ec0\u9ebc\u9700\u8981 API document\">1. \u70ba\u4ec0\u9ebc\u9700\u8981 API document<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/jimmyswebnote.com\/swagger-node-js-tutorial\/#2_Install_swagger-ui-express_dependency\" title=\"2. Install swagger-ui-express dependency\">2. Install swagger-ui-express dependency<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/jimmyswebnote.com\/swagger-node-js-tutorial\/#3_%E6%96%B0%E5%A2%9E_swaggerjson\" title=\"3. \u65b0\u589e swagger.json\">3. \u65b0\u589e swagger.json<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-4\" href=\"https:\/\/jimmyswebnote.com\/swagger-node-js-tutorial\/#4_%E5%8F%83%E8%80%83%E8%B3%87%E6%96%99\" title=\"4. \u53c3\u8003\u8cc7\u6599\">4. \u53c3\u8003\u8cc7\u6599<\/a><\/li><\/ul><\/nav><\/div>\n<h2><span class=\"ez-toc-section\" id=\"1_%E7%82%BA%E4%BB%80%E9%BA%BC%E9%9C%80%E8%A6%81_API_document\"><\/span>1. \u70ba\u4ec0\u9ebc\u9700\u8981 API document<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<p>\u5728\u4e0a\u4e00\u7bc7 <a href=\"https:\/\/jimmyswebnote.com\/node-js-restful-api-tutorial\/\" target=\"_blank\" rel=\"noreferrer noopener\">\u524d\u7aef\u5de5\u7a0b\u5e2b\u9081\u5411\u5f8c\u7aef\u4e4b\u8def 7 \u2013 \u5be6\u4f5c Node.js RESTful API<\/a> \u5beb\u5b8c API \u5f8c\uff0c\u63a5\u8457\u5c31\u662f\u8981\u4f86\u5beb document \u4e86\uff0c\u901a\u5e38\u5f8c\u7aef\u5de5\u7a0b\u5e2b\u5beb\u5b8c API \u5f8c\u5fc5\u9808\u7522\u751f\u76f8\u5c0d\u61c9\u7684 API document \u624d\u80fd\u8b93\u524d\u7aef\u5de5\u7a0b\u5e2b\u77e5\u9053\u4e1f\u4ec0\u9ebc\u6a23\u683c\u5f0f\u7684 http request \u624d\u6703\u62ff\u5230\u4ec0\u9ebc\u6a23\u7684 http response\uff0c\u4ee5 <a href=\"https:\/\/developer.foreca.com\/#Forecasts\" target=\"_blank\" data-type=\"URL\" data-id=\"https:\/\/developer.foreca.com\/#Forecasts\" rel=\"noreferrer noopener\">Foreca<\/a> \u9019\u500b\u7db2\u7ad9\u70ba\u4f8b\uff0c\u4ed6\u5011\u6709\u63d0\u4f9b API \u7d66\u958b\u767c\u8005\u4e32\u63a5\uff0c\u56e0\u6b64 API \u7684 document \u5c31\u9700\u8981\u5beb\u5f97\u8d8a\u6e05\u695a\u8d8a\u597d\uff1a<\/p>\n\n\n\n<div class=\"wp-block-image\"><figure class=\"aligncenter size-large is-resized\"><a href=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js.png\"><img loading=\"lazy\" src=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-1024x816.png\" alt=\"Swagger Node.js\" class=\"wp-image-2172\" width=\"976\" height=\"777\" srcset=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-1024x816.png 1024w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-300x239.png 300w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-768x612.png 768w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js.png 1414w\" sizes=\"(max-width: 976px) 100vw, 976px\" \/><\/a><figcaption>\u25b2 Foreca API document<\/figcaption><\/figure><\/div>\n\n\n\n<p>\u800c\u4eca\u5929\u8981\u7528\u4f86\u5beb API document \u7684\u5de5\u5177\u662f <a href=\"https:\/\/swagger.io\/\" data-type=\"URL\" data-id=\"https:\/\/swagger.io\/\" target=\"_blank\" rel=\"noreferrer noopener\">Swagger<\/a>\uff0cSwagger \u5f37\u5927\u7684\u5730\u65b9\u5728\u65bc\uff0c\u53ea\u9700\u8981\u5beb\u4e00\u500b json \u6a94\uff0c\u5c31\u53ef\u4ee5\u52d5\u7522\u751f\u51fa API document \u5728\u7db2\u9801\u4e0a\u700f\u89bd\uff0c\u9084\u53ef\u4ee5\u76f4\u63a5\u767c\u9001 http request \u4f86\u6e2c\u8a66 API\u3002<\/p>\n\n\n\n<h2><span class=\"ez-toc-section\" id=\"2_Install_swagger-ui-express_dependency\"><\/span>2. Install swagger-ui-express dependency<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"bash\" class=\"language-bash\">$ yarn add swagger-ui-express<\/code><\/pre>\n\n\n\n<p>\u9019\u500b dependency \u6703\u76f4\u63a5\u5c07\u6211\u5011\u7684 json \u8f49\u63db\u70ba API document\u3002<\/p>\n\n\n\n<h2><span class=\"ez-toc-section\" id=\"3_%E6%96%B0%E5%A2%9E_swaggerjson\"><\/span>3. \u65b0\u589e swagger.json<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<p>\u5728 src \u5e95\u4e0b\u65b0\u589e swagger.json\u3002<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"json\" class=\"language-json\">{\n  \"openapi\": \"3.0.0\",\n  \"info\": {\n    \"title\": \"User API\",\n    \"description\": \"Simple RESTful API in Node.js with TypeScript\",\n    \"version\": \"0.0.1\"\n  },\n  \"servers\": [\n    {\n      \"url\": \"http:\/\/localhost:3000\/api\",\n      \"description\": \"Local server\"\n    }\n  ],\n}<\/code><\/pre>\n\n\n\n<p>\u9019\u88e1\u53ef\u4ee5\u586b\u4e00\u4e9b server \u548c API k\u7684\u76f8\u95dc\u8cc7\u8a0a\u3002<\/p>\n\n\n\n<p>\u586b\u5b8c\u4e4b\u5f8c\u8981\u5728 index.ts import \u9019\u500b\u6a94\u6848\uff1a<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"typescript\" class=\"language-typescript\">import swaggerUi from 'swagger-ui-express';\n\nconst swaggerDocument = require('.\/swagger.json');\n\napp.use('\/api\/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));\n...<\/code><\/pre>\n\n\n\n<p>\u628a server \u8dd1\u8d77\u4f86\u5f8c\uff0c\u7528\u700f\u89bd\u5668\u6253\u958b <code>http:\/\/localhost:3000\/api\/docs<\/code>\uff0c\u6703\u51fa\u73fe\u4ee5\u4e0b\u7684\u756b\u9762\uff1a<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><a href=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-1.png\"><img loading=\"lazy\" width=\"1024\" height=\"632\" src=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-1-1024x632.png\" alt=\"Swagger Node.js\" class=\"wp-image-2174\" srcset=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-1-1024x632.png 1024w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-1-300x185.png 300w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-1-768x474.png 768w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-1-1536x948.png 1536w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-1.png 1830w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/a><\/figure>\n\n\n\n<p>\u9019\u6a23\u5c31\u4ee3\u8868\u6709\u6210\u529f\u7522\u751f API document \u4e86\uff01\u63a5\u8457\u6211\u5011\u5c31\u53ef\u4ee5\u4f86\u5beb API document \u4e86\uff0c\u4e00\u4e9b\u8a73\u7d30\u7684\u898f\u683c\u53ef\u4ee5\u53c3\u8003\uff1a<a href=\"https:\/\/github.com\/OAI\/OpenAPI-Specification\/blob\/main\/versions\/3.0.3.md\" target=\"_blank\" rel=\"noreferrer noopener\">OpenAPI-Specification\/3.0.3.md at main \u00b7 OAI\/OpenAPI-Specification<\/a>\uff0c\u5982\u679c\u60f3\u8981\u5feb\u901f\u5165\u9580\u53ef\u4ee5\u53c3\u8003\uff1a<a href=\"https:\/\/swagger.io\/docs\/specification\/basic-structure\/\" target=\"_blank\" rel=\"noreferrer noopener\" data-type=\"URL\" data-id=\"https:\/\/swagger.io\/docs\/specification\/basic-structure\/\">Swagger: API Documentation &amp; Design Tools for Teams<\/a>\uff0c\u9019\u908a\u5148\u4ee5 GET \/api\/users \u53d6\u5f97\u6240\u6709 user \u8cc7\u6599\u7684 API \u70ba\u4f8b\uff1a<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"json\" class=\"language-json\">{\n  \"openapi\": \"3.0.0\",\n  \"info\": {\n    \"title\": \"User API\",\n    \"description\": \"Simple RESTful API in Node.js with TypeScript\",\n    \"version\": \"0.0.1\"\n  },\n  \"servers\": [\n    {\n      \"url\": \"http:\/\/localhost:3000\/api\",\n      \"description\": \"Local server\"\n    }\n  ],\n  \"paths\": {\n    \"\/users\": {\n      \"get\": {\n        \"summary\": \"Return all users with list.\",\n        \"description\": \"Return all existed users.\",\n        \"responses\": {\n          \"200\": {\n            \"description\": \"A JSON array of user names\",\n            \"content\": {\n              \"application\/json\": {\n                \"schema\": {\n                  \"type\": \"array\",\n                  \"items\": {\n                    \"$ref\": \"#\/components\/schemas\/User\"\n                  }\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  },\n  \"components\": {\n    \"schemas\": {\n      \"User\": {\n        \"properties\": {\n          \"id\": {\n            \"type\": \"integer\",\n            \"format\": \"int64\",\n            \"example\": 1\n          },\n          \"username\": {\n            \"type\": \"string\",\n            \"example\": \"Jimmy\"\n          },\n          \"email\": {\n            \"type\": \"string\",\n            \"example\": \"test@test.com\"\n          }\n        },\n        \"required\": [\"id\", \"username\", \"email\"]\n      }\n    }\n  }\n}<\/code><\/pre>\n\n\n\n<p>\u6700\u5f8c\u4e00\u500b property: components \u88e1\u7684 schema \u662f\u70ba\u4e86\u8b93 API document \u53ef\u4ee5\u91cd\u8907\u4f7f\u7528\u6240\u4ee5\u624d\u5b9a\u7fa9\u5728\u5916\u9762\u7684\uff0c\u5426\u5247\u6bcf\u4e00\u500b API \u90fd\u8981\u91cd\u65b0\u5b9a\u7fa9 schema \u6703\u8b8a\u5f97\u592a\u5197\u9577\uff0c\u5beb\u5b8c\u4e4b\u5f8c\u91cd\u65b0\u6574\u7406\u7db2\u9801\uff1a<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><a href=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/\u622a\u5716-2021-08-24-\u4e0b\u53486.16.47.png\"><img loading=\"lazy\" width=\"1024\" height=\"227\" src=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/\u622a\u5716-2021-08-24-\u4e0b\u53486.16.47-1024x227.png\" alt=\"Swagger Node.js\" class=\"wp-image-2176\" srcset=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/\u622a\u5716-2021-08-24-\u4e0b\u53486.16.47-1024x227.png 1024w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/\u622a\u5716-2021-08-24-\u4e0b\u53486.16.47-300x67.png 300w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/\u622a\u5716-2021-08-24-\u4e0b\u53486.16.47-768x170.png 768w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/\u622a\u5716-2021-08-24-\u4e0b\u53486.16.47-1536x340.png 1536w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/\u622a\u5716-2021-08-24-\u4e0b\u53486.16.47-2048x454.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/a><\/figure>\n\n\n\n<p>\u767c\u73fe\u525b\u525b\u5beb\u7684 API \u8b8a\u6210 document \u7684\u5f62\u5f0f\u4e86\uff01\u9ede\u958b\u4e4b\u5f8c\u6703\u6709\u9019\u652f API \u7684\u8a73\u7d30\u8cc7\u6599\uff1a request \u7684\u683c\u5f0f\uff0cresponse \u7684 schema \u7b49\u7b49\uff1a<\/p>\n\n\n\n<div class=\"wp-block-columns\">\n<div class=\"wp-block-column\">\n<figure class=\"wp-block-image size-large\"><a href=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-2.png\"><img loading=\"lazy\" width=\"1024\" height=\"547\" src=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-2-1024x547.png\" alt=\"Swagger Node.js\" class=\"wp-image-2177\" srcset=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-2-1024x547.png 1024w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-2-300x160.png 300w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-2-768x410.png 768w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-2-1536x821.png 1536w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-2-2048x1094.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/a><\/figure>\n<\/div>\n\n\n\n<div class=\"wp-block-column\">\n<figure class=\"wp-block-image size-large\"><a href=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-3.png\"><img loading=\"lazy\" width=\"1024\" height=\"568\" src=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-3-1024x568.png\" alt=\"Swagger Node.js\" class=\"wp-image-2178\" srcset=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-3-1024x568.png 1024w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-3-300x167.png 300w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-3-768x426.png 768w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-3-1536x853.png 1536w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-3-2048x1137.png 2048w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/a><\/figure>\n<\/div>\n<\/div>\n\n\n\n<p>\u9ede\u64ca Try it out \u5f8c\u6703\u51fa\u73fe\u4e00\u500b Execute button\uff0c\u9ede\u64ca Execute \u6703\u76f4\u63a5 send http request\uff0c\u5c31\u50cf Postman \u4e00\u6a23\u3002<\/p>\n\n\n\n<p>\u5b8c\u6574\u7684 Swagger.json\uff1a<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code lang=\"json\" class=\"language-json\">{\n  \"openapi\": \"3.0.0\",\n  \"info\": {\n    \"title\": \"User API\",\n    \"description\": \"Simple RESTful API in Node.js with TypeScript\",\n    \"version\": \"0.0.1\"\n  },\n  \"servers\": [\n    {\n      \"url\": \"http:\/\/localhost:3000\/api\",\n      \"description\": \"Local server\"\n    }\n  ],\n  \"paths\": {\n    \"\/users\": {\n      \"get\": {\n        \"summary\": \"Return all users with list.\",\n        \"description\": \"Return all existed users.\",\n        \"responses\": {\n          \"200\": {\n            \"description\": \"A JSON array of user names\",\n            \"content\": {\n              \"application\/json\": {\n                \"schema\": {\n                  \"type\": \"array\",\n                  \"items\": {\n                    \"$ref\": \"#\/components\/schemas\/User\"\n                  }\n                }\n              }\n            }\n          }\n        }\n      },\n      \"post\": {\n        \"summary\": \"Create a new user.\",\n        \"description\": \"Create a new user.\",\n        \"requestBody\": {\n          \"required\": true,\n          \"content\": {\n            \"application\/json\": {\n              \"schema\": {\n                \"$ref\": \"#\/components\/schemas\/UserInput\"\n              }\n            }\n          }\n        },\n        \"responses\": {\n          \"201\": {\n            \"description\": \"Success create user.\",\n            \"content\": {\n              \"text\/plain\": {\n                \"schema\": {\n                  \"type\": \"string\"\n                }\n              }\n            }\n          }\n        }\n      }\n    },\n    \"\/users\/{id}\": {\n      \"get\": {\n        \"summary\": \"Return the specific user.\",\n        \"description\": \"Return the specific user.\",\n        \"parameters\": [\n          {\n            \"name\": \"id\",\n            \"in\": \"path\",\n            \"description\": \"user id which wants to get\",\n            \"required\": true,\n            \"type\": \"string\"\n          }\n        ],\n        \"responses\": {\n          \"200\": {\n            \"description\": \"A JSON object of user\",\n            \"content\": {\n              \"application\/json\": {\n                \"schema\": {\n                  \"$ref\": \"#\/components\/schemas\/User\"\n                }\n              }\n            }\n          }\n        }\n      },\n      \"patch\": {\n        \"summary\": \"Update the specific user.\",\n        \"description\": \"Update the specific user.\",\n        \"parameters\": [\n          {\n            \"name\": \"id\",\n            \"in\": \"path\",\n            \"description\": \"user id which wants to update\",\n            \"required\": true,\n            \"type\": \"string\"\n          }\n        ],\n        \"requestBody\": {\n          \"required\": true,\n          \"content\": {\n            \"application\/json\": {\n              \"schema\": {\n                \"$ref\": \"#\/components\/schemas\/UserInput\"\n              }\n            }\n          }\n        },\n        \"responses\": {\n          \"204\": {\n            \"description\": \"Success update user.\",\n            \"content\": {\n              \"text\/plain\": {\n                \"schema\": {\n                  \"type\": \"string\"\n                }\n              }\n            }\n          }\n        }\n      },\n      \"delete\": {\n        \"summary\": \"Delete the specific user.\",\n        \"description\": \"Delete the specific user.\",\n        \"parameters\": [\n          {\n            \"name\": \"id\",\n            \"in\": \"path\",\n            \"description\": \"user id which wants to delete\",\n            \"required\": true,\n            \"type\": \"string\"\n          }\n        ],\n        \"responses\": {\n          \"204\": {\n            \"description\": \"Success delete user.\",\n            \"content\": {\n              \"text\/plain\": {\n                \"schema\": {\n                  \"type\": \"string\"\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  },\n  \"components\": {\n    \"schemas\": {\n      \"User\": {\n        \"properties\": {\n          \"id\": {\n            \"type\": \"integer\",\n            \"format\": \"int64\",\n            \"example\": 1\n          },\n          \"username\": {\n            \"type\": \"string\",\n            \"example\": \"Jimmy\"\n          },\n          \"email\": {\n            \"type\": \"string\",\n            \"example\": \"test@test.com\"\n          }\n        },\n        \"required\": [\"id\", \"username\", \"email\"]\n      },\n      \"UserInput\": {\n        \"properties\": {\n          \"username\": {\n            \"type\": \"string\",\n            \"example\": \"Jimmy\"\n          },\n          \"email\": {\n            \"type\": \"string\",\n            \"example\": \"test@test.com\"\n          }\n        },\n        \"required\": [\"username\", \"email\"]\n      }\n    }\n  }\n}<\/code><\/pre>\n\n\n\n<p>\u4ee5\u4e0a\u7684\u7de8\u5beb\u898f\u5247\u90fd\u662f\u6309\u7167 <a href=\"https:\/\/github.com\/OAI\/OpenAPI-Specification\/blob\/main\/versions\/3.0.3.md\" target=\"_blank\" rel=\"noreferrer noopener\">OpenAPI-Specification\/3.0.3.md at main \u00b7 OAI\/OpenAPI-Specification<\/a> \u7684\u898f\u7bc4\u3002\u5beb\u5b8c\u4e4b\u5f8c\u91cd\u65b0\u6574\u7406\u9801\u9762\uff1a<\/p>\n\n\n\n<figure class=\"wp-block-image size-large\"><a href=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-4.png\"><img loading=\"lazy\" width=\"1024\" height=\"719\" src=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-4-1024x719.png\" alt=\"Swagger Node.js\" class=\"wp-image-2180\" srcset=\"https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-4-1024x719.png 1024w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-4-300x211.png 300w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-4-768x539.png 768w, https:\/\/jimmyswebnote.com\/wp-content\/uploads\/2021\/08\/Swagger-Node-js-4.png 1462w\" sizes=\"(max-width: 1024px) 100vw, 1024px\" \/><\/a><\/figure>\n\n\n\n<p>\u6240\u6709\u7684 API document \u90fd\u5b8c\u6210\u4e86\uff01\u800c\u4e14\u5b9a\u7fa9\u7684\u6240\u6709 schema \u4e5f\u90fd\u6703\u986f\u793a\u5728 API \u5e95\u4e0b\uff0c\u7c21\u55ae\u5b8c\u6210\u4e86 RESTful API document\u3002<\/p>\n\n\n\n<p>\u9019\u7cfb\u5217\u7684\u5728 Node.js \u5be6\u4f5c RESTful API \u5c31\u5230\u9019\u908a\u5566\uff0c\u5e0c\u671b\u9019\u7cfb\u5217\u7684\u6587\u7ae0\u5c0d\u4f60\u6709\u5e6b\u52a9~\u5b8c\u6574\u7684 code \u53ef\u4ee5\u53c3\u8003\uff1a<a href=\"https:\/\/github.com\/jimmy2952\/Node.js-RESTful-API-tutorial\" target=\"_blank\" rel=\"noreferrer noopener\">https:\/\/github.com\/jimmy2952\/Node.js-RESTful-API-tutorial<\/a>\u3002<\/p>\n\n\n\n<h2><span class=\"ez-toc-section\" id=\"4_%E5%8F%83%E8%80%83%E8%B3%87%E6%96%99\"><\/span>4. \u53c3\u8003\u8cc7\u6599<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<p><a href=\"https:\/\/swagger.io\/\" target=\"_blank\" rel=\"noreferrer noopener\">Swagger: API Documentation &amp; Design Tools for Teams<\/a><br><a href=\"https:\/\/github.com\/OAI\/OpenAPI-Specification\/blob\/main\/versions\/3.0.3.md\" target=\"_blank\" data-type=\"URL\" data-id=\"https:\/\/github.com\/OAI\/OpenAPI-Specification\/blob\/main\/versions\/3.0.3.md\" rel=\"noreferrer noopener\">OpenAPI-Specification\/3.0.3.md at main \u00b7 OAI\/OpenAPI-Specification<\/a><br><a href=\"https:\/\/medium.com\/jasmine880809\/swagger-%E8%87%AA%E5%8B%95%E7%94%A2%E7%94%9Fapi%E6%96%87%E4%BB%B6-node-js-%E5%AF%A6%E4%BD%9C-e39f2bde57ce\" target=\"_blank\" data-type=\"URL\" data-id=\"https:\/\/medium.com\/jasmine880809\/swagger-%E8%87%AA%E5%8B%95%E7%94%A2%E7%94%9Fapi%E6%96%87%E4%BB%B6-node-js-%E5%AF%A6%E4%BD%9C-e39f2bde57ce\" rel=\"noreferrer noopener\">Swagger-\u81ea\u52d5\u7522\u751fAPI\u6587\u4ef6 (Node.js \u5be6\u4f5c+\u7bc4\u4f8b\u7a0b\u5f0f\u78bc)<\/a><br><a href=\"https:\/\/medium.com\/bb-tutorials-and-thoughts\/how-to-add-swagger-to-nodejs-rest-api-typescript-version-5a63953c993b\" target=\"_blank\" data-type=\"URL\" data-id=\"https:\/\/medium.com\/bb-tutorials-and-thoughts\/how-to-add-swagger-to-nodejs-rest-api-typescript-version-5a63953c993b\" rel=\"noreferrer noopener\">How To Add Swagger To NodeJS REST API \u2014 Typescript Version<\/a><\/p>\n\n\n\n\n\n<p>\u5982\u679c\u89ba\u5f97\u6211\u7684\u6587\u7ae0\u6709\u5e6b\u52a9\u7684\u8a71\uff0c\u6b61\u8fce\u5e6b\u6211\u7684\u7c89\u5c08\u6309\u8b9a\u54e6~\u8b1d\u8b1d\u4f60\uff01<br><\/p>\n\n<iframe loading=\"lazy\" src=\"https:\/\/www.facebook.com\/plugins\/page.php?href=https%3A%2F%2Fwww.facebook.com%2Fjimmyswebnote&amp;tabs=timeline&amp;width=340&amp;height=500&amp;small_header=false&amp;adapt_container_width=true&amp;hide_cover=false&amp;show_facepile=true&amp;appId\" width=\"340\" height=\"500\" style=\"border:none;overflow:hidden\" scrolling=\"no\" frameborder=\"0\" allowfullscreen=\"true\" allow=\"autoplay; clipboard-write; encrypted-media; picture-in-picture; web-share\"><\/iframe>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Swagger Node.js \u6559\u5b78 \u5728\u4e0a\u4e00\u7bc7 \u524d\u7aef\u5de5\u7a0b\u5e2b\u9081\u5411\u5f8c\u7aef\u4e4b\u8def 7 \u2013 \u5be6\u4f5c Node.js RESTful API \u5beb\u5b8c API \u5f8c\uff0c\u63a5\u8457\u5c31\u662f\u8981\u4f86\u5beb document \u4e86\uff0c\u901a\u5e38\u5f8c\u7aef\u5de5\u7a0b\u5e2b\u5beb\u5b8c API \u5f8c\u5fc5\u9808\u7522\u751f\u76f8\u5c0d\u61c9\u7684 API document \u624d\u80fd\u8b93\u524d\u7aef\u5de5\u7a0b\u5e2b\u77e5\u9053\u4e1f\u4ec0\u9ebc\u6a23\u683c\u5f0f\u7684 http request \u624d\u6703\u62ff\u5230\u4ec0\u9ebc\u6a23\u7684 http response<\/p>\n","protected":false},"author":1,"featured_media":2181,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[91,90],"tags":[143],"_links":{"self":[{"href":"https:\/\/jimmyswebnote.com\/wp-json\/wp\/v2\/posts\/2170"}],"collection":[{"href":"https:\/\/jimmyswebnote.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/jimmyswebnote.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/jimmyswebnote.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/jimmyswebnote.com\/wp-json\/wp\/v2\/comments?post=2170"}],"version-history":[{"count":0,"href":"https:\/\/jimmyswebnote.com\/wp-json\/wp\/v2\/posts\/2170\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/jimmyswebnote.com\/wp-json\/wp\/v2\/media\/2181"}],"wp:attachment":[{"href":"https:\/\/jimmyswebnote.com\/wp-json\/wp\/v2\/media?parent=2170"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/jimmyswebnote.com\/wp-json\/wp\/v2\/categories?post=2170"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/jimmyswebnote.com\/wp-json\/wp\/v2\/tags?post=2170"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}