{"id":13954,"date":"2024-11-15T23:06:50","date_gmt":"2024-11-15T15:06:50","guid":{"rendered":"https:\/\/fwq.ai\/blog\/13954\/"},"modified":"2024-11-15T23:06:50","modified_gmt":"2024-11-15T15:06:50","slug":"docker%e4%b8%8eswagger%e9%9b%86%e6%88%90%e5%ae%9e%e7%8e%b0api%e6%96%87%e6%a1%a3%e7%9a%84%e8%87%aa%e5%8a%a8%e7%94%9f%e6%88%90%e4%b8%8e%e7%ae%a1%e7%90%86","status":"publish","type":"post","link":"https:\/\/fwq.ai\/blog\/13954\/","title":{"rendered":"Docker\u4e0eSwagger\u96c6\u6210\u5b9e\u73b0API\u6587\u6863\u7684\u81ea\u52a8\u751f\u6210\u4e0e\u7ba1\u7406"},"content":{"rendered":"<h1 id=\"docker%e4%b8%8eswagger%e9%9b%86%e6%88%90%e5%ae%9e%e7%8e%b0api%e6%96%87%e6%a1%a3%e7%9a%84%e8%87%aa%e5%8a%a8%e7%94%9f%e6%88%90%e4%b8%8e%e7%ae%a1%e7%90%86-ttROmbiaDi\">Docker\u4e0eSwagger\u96c6\u6210\u5b9e\u73b0API\u6587\u6863\u7684\u81ea\u52a8\u751f\u6210\u4e0e\u7ba1\u7406<\/h1>\n<p>\u5728\u73b0\u4ee3\u8f6f\u4ef6\u5f00\u53d1\u4e2d\uff0cAPI\uff08\u5e94\u7528\u7a0b\u5e8f\u7f16\u7a0b\u63a5\u53e3\uff09\u626e\u6f14\u7740\u81f3\u5173\u91cd\u8981\u7684\u89d2\u8272\u3002\u968f\u7740\u5fae\u670d\u52a1\u67b6\u6784\u7684\u666e\u53ca\uff0c\u5f00\u53d1\u8005\u9700\u8981\u4e00\u79cd\u9ad8\u6548\u7684\u65b9\u5f0f\u6765\u7ba1\u7406\u548c\u6587\u6863\u5316API\u3002Docker\u548cSwagger\u7684\u7ed3\u5408\u4e3a\u8fd9\u4e00\u9700\u6c42\u63d0\u4f9b\u4e86\u5b8c\u7f8e\u7684\u89e3\u51b3\u65b9\u6848\u3002\u672c\u6587\u5c06\u63a2\u8ba8\u5982\u4f55\u901a\u8fc7Docker\u4e0eSwagger\u96c6\u6210\uff0c\u5b9e\u73b0API\u6587\u6863\u7684\u81ea\u52a8\u751f\u6210\u4e0e\u7ba1\u7406\u3002<\/p>\n<h2 id=\"%e4%bb%80%e4%b9%88%e6%98%afdocker%ef%bc%9f-ttROmbiaDi\">\u4ec0\u4e48\u662fDocker\uff1f<\/h2>\n<p>Docker\u662f\u4e00\u79cd\u5f00\u6e90\u7684\u5bb9\u5668\u5316\u5e73\u53f0\uff0c\u5141\u8bb8\u5f00\u53d1\u8005\u5c06\u5e94\u7528\u7a0b\u5e8f\u53ca\u5176\u4f9d\u8d56\u9879\u6253\u5305\u5230\u4e00\u4e2a\u8f7b\u91cf\u7ea7\u7684\u5bb9\u5668\u4e2d\u3002\u5bb9\u5668\u53ef\u4ee5\u5728\u4efb\u4f55\u652f\u6301Docker\u7684\u73af\u5883\u4e2d\u8fd0\u884c\uff0c\u786e\u4fdd\u4e86\u5e94\u7528\u7a0b\u5e8f\u7684\u4e00\u81f4\u6027\u548c\u53ef\u79fb\u690d\u6027\u3002Docker\u7684\u4e3b\u8981\u4f18\u52bf\u5305\u62ec\uff1a<\/p>\n<ul>\n<li>\u73af\u5883\u4e00\u81f4\u6027\uff1a\u65e0\u8bba\u5728\u5f00\u53d1\u3001\u6d4b\u8bd5\u8fd8\u662f\u751f\u4ea7\u73af\u5883\u4e2d\uff0cDocker\u5bb9\u5668\u90fd\u80fd\u63d0\u4f9b\u76f8\u540c\u7684\u8fd0\u884c\u73af\u5883\u3002<\/li>\n<li>\u8d44\u6e90\u9694\u79bb\uff1a\u6bcf\u4e2a\u5bb9\u5668\u90fd\u662f\u72ec\u7acb\u7684\uff0c\u907f\u514d\u4e86\u4e0d\u540c\u5e94\u7528\u4e4b\u95f4\u7684\u76f8\u4e92\u5e72\u6270\u3002<\/li>\n<li>\u5feb\u901f\u90e8\u7f72\uff1a\u5bb9\u5668\u7684\u542f\u52a8\u901f\u5ea6\u6781\u5feb\uff0c\u80fd\u591f\u8fc5\u901f\u54cd\u5e94\u4e1a\u52a1\u9700\u6c42\u3002<\/li>\n<\/ul>\n<h2 id=\"%e4%bb%80%e4%b9%88%e6%98%afswagger%ef%bc%9f-ttROmbiaDi\">\u4ec0\u4e48\u662fSwagger\uff1f<\/h2>\n<p>Swagger\u662f\u4e00\u79cd\u7528\u4e8e\u63cf\u8ff0\u548c\u6587\u6863\u5316RESTful API\u7684\u5de5\u5177\u3002\u5b83\u63d0\u4f9b\u4e86\u4e00\u79cd\u6807\u51c6\u5316\u7684\u65b9\u5f0f\u6765\u5b9a\u4e49API\u7684\u7ed3\u6784\uff0c\u4f7f\u5f97\u5f00\u53d1\u8005\u548c\u7528\u6237\u80fd\u591f\u66f4\u5bb9\u6613\u5730\u7406\u89e3\u548c\u4f7f\u7528API\u3002Swagger\u7684\u4e3b\u8981\u7279\u70b9\u5305\u62ec\uff1a<\/p>\n<ul>\n<li>\u53ef\u89c6\u5316\u6587\u6863\uff1aSwagger UI\u63d0\u4f9b\u4e86\u4e00\u4e2a\u7528\u6237\u53cb\u597d\u7684\u754c\u9762\uff0c\u65b9\u4fbf\u7528\u6237\u67e5\u770b\u548c\u6d4b\u8bd5API\u3002<\/li>\n<li>\u81ea\u52a8\u751f\u6210\u6587\u6863\uff1a\u901a\u8fc7\u6ce8\u91ca\u4ee3\u7801\uff0cSwagger\u53ef\u4ee5\u81ea\u52a8\u751f\u6210API\u6587\u6863\uff0c\u51cf\u5c11\u4e86\u624b\u52a8\u7ef4\u62a4\u7684\u5de5\u4f5c\u91cf\u3002<\/li>\n<li>\u652f\u6301\u591a\u79cd\u8bed\u8a00\uff1aSwagger\u652f\u6301\u591a\u79cd\u7f16\u7a0b\u8bed\u8a00\uff0c\u9002\u7528\u4e8e\u4e0d\u540c\u7684\u5f00\u53d1\u73af\u5883\u3002<\/li>\n<\/ul>\n<h2 id=\"docker%e4%b8%8eswagger%e7%9a%84%e9%9b%86%e6%88%90-ttROmbiaDi\">Docker\u4e0eSwagger\u7684\u96c6\u6210<\/h2>\n<p>\u5c06Docker\u4e0eSwagger\u7ed3\u5408\u4f7f\u7528\uff0c\u53ef\u4ee5\u5b9e\u73b0API\u6587\u6863\u7684\u81ea\u52a8\u751f\u6210\u4e0e\u7ba1\u7406\u3002\u4ee5\u4e0b\u662f\u5b9e\u73b0\u8fd9\u4e00\u96c6\u6210\u7684\u57fa\u672c\u6b65\u9aa4\uff1a<\/p>\n<h3 id=\"%e6%ad%a5%e9%aa%a4%e4%b8%80%ef%bc%9a%e5%88%9b%e5%bb%badockerfile-ttROmbiaDi\">\u6b65\u9aa4\u4e00\uff1a\u521b\u5efaDockerfile<\/h3>\n<p>\u9996\u5148\uff0c\u9700\u8981\u521b\u5efa\u4e00\u4e2aDockerfile\u6765\u5b9a\u4e49\u5e94\u7528\u7a0b\u5e8f\u7684\u73af\u5883\u3002\u4ee5\u4e0b\u662f\u4e00\u4e2a\u7b80\u5355\u7684\u793a\u4f8b\uff1a<\/p>\n<pre><code>FROM node:14\n\nWORKDIR \/usr\/src\/app\n\nCOPY package*.json .\/\nRUN npm install\n\nCOPY . .\n\nEXPOSE 3000\nCMD [\"node\", \"app.js\"]<\/code><\/pre>\n<h3 id=\"%e6%ad%a5%e9%aa%a4%e4%ba%8c%ef%bc%9a%e5%ae%89%e8%a3%85swagger%e4%be%9d%e8%b5%96-ttROmbiaDi\">\u6b65\u9aa4\u4e8c\uff1a\u5b89\u88c5Swagger\u4f9d\u8d56<\/h3>\n<p>\u5728\u9879\u76ee\u4e2d\u5b89\u88c5Swagger\u76f8\u5173\u7684\u4f9d\u8d56\u3002\u4ee5Node.js\u4e3a\u4f8b\uff0c\u53ef\u4ee5\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\uff1a<\/p>\n<pre><code>npm install swagger-jsdoc swagger-ui-express<\/code><\/pre>\n<h3 id=\"%e6%ad%a5%e9%aa%a4%e4%b8%89%ef%bc%9a%e9%85%8d%e7%bd%aeswagger-ttROmbiaDi\">\u6b65\u9aa4\u4e09\uff1a\u914d\u7f6eSwagger<\/h3>\n<p>\u5728\u5e94\u7528\u7a0b\u5e8f\u4e2d\u914d\u7f6eSwagger\uff0c\u4ee5\u4fbf\u81ea\u52a8\u751f\u6210API\u6587\u6863\u3002\u4ee5\u4e0b\u662f\u4e00\u4e2a\u57fa\u672c\u7684\u914d\u7f6e\u793a\u4f8b\uff1a<\/p>\n<pre><code>const swaggerJsDoc = require('swagger-jsdoc');\nconst swaggerUi = require('swagger-ui-express');\n\nconst swaggerOptions = {\n    swaggerDefinition: {\n        openapi: '3.0.0',\n        info: {\n            title: 'API\u6587\u6863',\n            version: '1.0.0',\n            description: 'API\u63cf\u8ff0',\n        },\n    },\n    apis: ['.\/routes\/*.js'], \/\/ \u6307\u5b9aAPI\u6587\u6863\u7684\u8def\u5f84\n};\n\nconst swaggerDocs = swaggerJsDoc(swaggerOptions);\napp.use('\/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));<\/code><\/pre>\n<h3 id=\"%e6%ad%a5%e9%aa%a4%e5%9b%9b%ef%bc%9a%e6%9e%84%e5%bb%ba%e5%92%8c%e8%bf%90%e8%a1%8cdocker%e5%ae%b9%e5%99%a8-ttROmbiaDi\">\u6b65\u9aa4\u56db\uff1a\u6784\u5efa\u548c\u8fd0\u884cDocker\u5bb9\u5668<\/h3>\n<p>\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u6784\u5efaDocker\u955c\u50cf\u5e76\u8fd0\u884c\u5bb9\u5668\uff1a<\/p>\n<pre><code>docker build -t my-api .\ndocker run -p 3000:3000 my-api<\/code><\/pre>\n<p>\u73b0\u5728\uff0c\u8bbf\u95ee <code>http:\/\/localhost:3000\/api-docs<\/code>\uff0c\u5373\u53ef\u67e5\u770b\u81ea\u52a8\u751f\u6210\u7684API\u6587\u6863\u3002<\/p>\n<h2 id=\"%e6%80%bb%e7%bb%93-ttROmbiaDi\">\u603b\u7ed3<\/h2>\n<p>\u901a\u8fc7\u5c06Docker\u4e0eSwagger\u96c6\u6210\uff0c\u5f00\u53d1\u8005\u53ef\u4ee5\u5b9e\u73b0API\u6587\u6863\u7684\u81ea\u52a8\u751f\u6210\u4e0e\u7ba1\u7406\uff0c\u6781\u5927\u5730\u63d0\u9ad8\u4e86\u5f00\u53d1\u6548\u7387\u548c\u6587\u6863\u7684\u51c6\u786e\u6027\u3002\u8fd9\u79cd\u65b9\u6cd5\u4e0d\u4ec5\u7b80\u5316\u4e86\u6587\u6863\u7ef4\u62a4\u7684\u8fc7\u7a0b\uff0c\u8fd8\u786e\u4fdd\u4e86API\u7684\u53ef\u7528\u6027\u548c\u53ef\u7406\u89e3\u6027\u3002\u5bf9\u4e8e\u5e0c\u671b\u63d0\u5347\u5f00\u53d1\u6d41\u7a0b\u7684\u56e2\u961f\u6765\u8bf4\uff0cDocker\u4e0eSwagger\u7684\u7ed3\u5408\u65e0\u7591\u662f\u4e00\u4e2a\u503c\u5f97\u8003\u8651\u7684\u89e3\u51b3\u65b9\u6848\u3002<\/p>\n<p>\u5982\u679c\u60a8\u6b63\u5728\u5bfb\u627e\u9ad8\u6548\u7684 <a href=\"https:\/\/fwq.ai\">\u4e91\u670d\u52a1\u5668<\/a> \u89e3\u51b3\u65b9\u6848\uff0c\u7c73\u4e91\u63d0\u4f9b\u591a\u79cd\u670d\u52a1\uff0c\u5305\u62ec\u7f8e\u56fdVPS\u3001\u7f8e\u56fd\u4e91\u670d\u52a1\u5668\u7b49\uff0c\u5e2e\u52a9\u60a8\u66f4\u597d\u5730\u7ba1\u7406\u548c\u90e8\u7f72\u60a8\u7684\u5e94\u7528\u7a0b\u5e8f\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Docker\u4e0eSwagger\u96c6\u6210\u5b9e\u73b0API\u6587\u6863\u7684\u81ea\u52a8\u751f\u6210\u4e0e\u7ba1\u7406 \u5728\u73b0\u4ee3\u8f6f\u4ef6\u5f00\u53d1\u4e2d\uff0cAPI\uff08\u5e94\u7528\u7a0b\u5e8f\u7f16\u7a0b\u63a5\u53e3\uff09\u626e\u6f14\u7740\u81f3\u5173\u91cd\u8981\u7684\u89d2\u8272\u3002\u968f\u7740\u5fae\u670d\u52a1\u67b6\u6784\u7684\u666e\u53ca\uff0c\u5f00\u53d1\u8005\u9700\u8981\u4e00\u79cd\u9ad8\u6548\u7684\u65b9\u5f0f\u6765\u7ba1\u7406\u548c\u6587\u6863\u5316API\u3002Docker\u548cSwagger\u7684\u7ed3\u5408\u4e3a\u8fd9\u4e00\u9700\u6c42\u63d0\u4f9b\u4e86\u5b8c\u7f8e\u7684\u89e3\u51b3\u65b9\u6848\u3002\u672c\u6587\u5c06\u63a2\u8ba8\u5982\u4f55\u901a\u8fc7Docker\u4e0eSwagger\u96c6\u6210\uff0c\u5b9e\u73b0API\u6587\u6863\u7684\u81ea\u52a8\u751f\u6210\u4e0e\u7ba1\u7406\u3002 \u4ec0\u4e48\u662fDocker\uff1f Docker\u662f\u4e00\u79cd\u5f00\u6e90\u7684\u5bb9\u5668\u5316\u5e73\u53f0\uff0c\u5141\u8bb8\u5f00\u53d1\u8005\u5c06\u5e94\u7528\u7a0b\u5e8f\u53ca\u5176\u4f9d\u8d56\u9879\u6253\u5305\u5230\u4e00\u4e2a\u8f7b\u91cf\u7ea7\u7684\u5bb9\u5668\u4e2d\u3002\u5bb9\u5668\u53ef\u4ee5\u5728\u4efb\u4f55\u652f\u6301Docker\u7684\u73af\u5883\u4e2d\u8fd0\u884c\uff0c\u786e\u4fdd\u4e86\u5e94\u7528\u7a0b\u5e8f\u7684\u4e00\u81f4\u6027\u548c\u53ef\u79fb\u690d\u6027\u3002Docker\u7684\u4e3b\u8981\u4f18\u52bf\u5305\u62ec\uff1a \u73af\u5883\u4e00\u81f4\u6027\uff1a\u65e0\u8bba\u5728\u5f00\u53d1\u3001\u6d4b\u8bd5\u8fd8\u662f\u751f\u4ea7\u73af\u5883\u4e2d\uff0cDocker\u5bb9\u5668\u90fd\u80fd\u63d0\u4f9b\u76f8\u540c\u7684\u8fd0\u884c\u73af\u5883\u3002 \u8d44\u6e90\u9694\u79bb\uff1a\u6bcf\u4e2a\u5bb9\u5668\u90fd\u662f\u72ec\u7acb\u7684\uff0c\u907f\u514d\u4e86\u4e0d\u540c\u5e94\u7528\u4e4b\u95f4\u7684\u76f8\u4e92\u5e72\u6270\u3002 \u5feb\u901f\u90e8\u7f72\uff1a\u5bb9\u5668\u7684\u542f\u52a8\u901f\u5ea6\u6781\u5feb\uff0c\u80fd\u591f\u8fc5\u901f\u54cd\u5e94\u4e1a\u52a1\u9700\u6c42\u3002 \u4ec0\u4e48\u662fSwagger\uff1f Swagger\u662f\u4e00\u79cd\u7528\u4e8e\u63cf\u8ff0\u548c\u6587\u6863\u5316RESTful API\u7684\u5de5\u5177\u3002\u5b83\u63d0\u4f9b\u4e86\u4e00\u79cd\u6807\u51c6\u5316\u7684\u65b9\u5f0f\u6765\u5b9a\u4e49API\u7684\u7ed3\u6784\uff0c\u4f7f\u5f97\u5f00\u53d1\u8005\u548c\u7528\u6237\u80fd\u591f\u66f4\u5bb9\u6613\u5730\u7406\u89e3\u548c\u4f7f\u7528API\u3002Swagger\u7684\u4e3b\u8981\u7279\u70b9\u5305\u62ec\uff1a \u53ef\u89c6\u5316\u6587\u6863\uff1aSwagger UI\u63d0\u4f9b\u4e86\u4e00\u4e2a\u7528\u6237\u53cb\u597d\u7684\u754c\u9762\uff0c\u65b9\u4fbf\u7528\u6237\u67e5\u770b\u548c\u6d4b\u8bd5API\u3002 \u81ea\u52a8\u751f\u6210\u6587\u6863\uff1a\u901a\u8fc7\u6ce8\u91ca\u4ee3\u7801\uff0cSwagger\u53ef\u4ee5\u81ea\u52a8\u751f\u6210API\u6587\u6863\uff0c\u51cf\u5c11\u4e86\u624b\u52a8\u7ef4\u62a4\u7684\u5de5\u4f5c\u91cf\u3002 \u652f\u6301\u591a\u79cd\u8bed\u8a00\uff1aSwagger\u652f\u6301\u591a\u79cd\u7f16\u7a0b\u8bed\u8a00\uff0c\u9002\u7528\u4e8e\u4e0d\u540c\u7684\u5f00\u53d1\u73af\u5883\u3002 Docker\u4e0eSwagger\u7684\u96c6\u6210 \u5c06Docker\u4e0eSwagger\u7ed3\u5408\u4f7f\u7528\uff0c\u53ef\u4ee5\u5b9e\u73b0API\u6587\u6863\u7684\u81ea\u52a8\u751f\u6210\u4e0e\u7ba1\u7406\u3002\u4ee5\u4e0b\u662f\u5b9e\u73b0\u8fd9\u4e00\u96c6\u6210\u7684\u57fa\u672c\u6b65\u9aa4\uff1a \u6b65\u9aa4\u4e00\uff1a\u521b\u5efaDockerfile \u9996\u5148\uff0c\u9700\u8981\u521b\u5efa\u4e00\u4e2aDockerfile\u6765\u5b9a\u4e49\u5e94\u7528\u7a0b\u5e8f\u7684\u73af\u5883\u3002\u4ee5\u4e0b\u662f\u4e00\u4e2a\u7b80\u5355\u7684\u793a\u4f8b\uff1a FROM node:14 WORKDIR \/usr\/src\/app COPY package*.json .\/ RUN npm install COPY . . EXPOSE 3000 CMD [&#8220;node&#8221;, &#8220;app.js&#8221;] \u6b65\u9aa4\u4e8c\uff1a\u5b89\u88c5Swagger\u4f9d\u8d56 \u5728\u9879\u76ee\u4e2d\u5b89\u88c5Swagger\u76f8\u5173\u7684\u4f9d\u8d56\u3002\u4ee5Node.js\u4e3a\u4f8b\uff0c\u53ef\u4ee5\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\uff1a npm install swagger-jsdoc swagger-ui-express \u6b65\u9aa4\u4e09\uff1a\u914d\u7f6eSwagger \u5728\u5e94\u7528\u7a0b\u5e8f\u4e2d\u914d\u7f6eSwagger\uff0c\u4ee5\u4fbf\u81ea\u52a8\u751f\u6210API\u6587\u6863\u3002\u4ee5\u4e0b\u662f\u4e00\u4e2a\u57fa\u672c\u7684\u914d\u7f6e\u793a\u4f8b\uff1a const swaggerJsDoc = require(&#8216;swagger-jsdoc&#8217;); const swaggerUi = require(&#8216;swagger-ui-express&#8217;); const swaggerOptions = [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-13954","post","type-post","status-publish","format-standard","hentry","category-docker"],"_links":{"self":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/13954","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/comments?post=13954"}],"version-history":[{"count":0,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/13954\/revisions"}],"wp:attachment":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/media?parent=13954"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/categories?post=13954"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/tags?post=13954"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}