{"id":38380,"date":"2024-11-01T17:18:02","date_gmt":"2024-11-01T17:18:02","guid":{"rendered":"http:\/\/atmokpo.com\/w\/?p=38380"},"modified":"2024-11-26T06:44:29","modified_gmt":"2024-11-26T06:44:29","slug":"express-%ea%b0%9c%eb%b0%9c-%ea%b0%95%ec%a2%8c-%ec%9e%90%eb%8f%99-%eb%ac%b8%ec%84%9c%ed%99%94-%eb%8f%84%ea%b5%ac-%ec%82%ac%ec%9a%a9%eb%b2%95-%eb%b0%8f-%ec%84%a4%ec%a0%95","status":"publish","type":"post","link":"https:\/\/atmokpo.com\/w\/38380\/","title":{"rendered":"Express \uac1c\ubc1c \uac15\uc88c, \uc790\ub3d9 \ubb38\uc11c\ud654 \ub3c4\uad6c \uc0ac\uc6a9\ubc95 \ubc0f \uc124\uc815"},"content":{"rendered":"

<\/p>\n

Express\ub294 Node.js\ub97c \uc704\ud55c \uacbd\ub7c9\uc758 \uc6f9 \uc560\ud50c\ub9ac\ucf00\uc774\uc158 \ud504\ub808\uc784\uc6cc\ud06c\ub85c, RESTful API\ub97c \uac1c\ubc1c\ud558\ub294 \ub370 \ub9e4\uc6b0 \uc720\uc6a9\ud569\ub2c8\ub2e4. \uc774\ub7ec\ud55c API\ub97c \ubb38\uc11c\ud654\ud558\ub294 \uac83\uc740 \uac1c\ubc1c\uc790\uc640 \uc0ac\uc6a9\uc790, \uadf8\ub9ac\uace0 \ud300 \uac04\uc758 \uc18c\ud1b5\uc744 \uc6d0\ud65c\ud558\uac8c \ud574\uc8fc\ub294 \uc911\uc694\ud55c \uc791\uc5c5\uc785\ub2c8\ub2e4. \uc774 \uae00\uc5d0\uc11c\ub294 Express \uc11c\ubc84\ub97c \uad6c\ucd95\ud558\uace0, \uc790\ub3d9\uc73c\ub85c API \ubb38\uc11c\ub97c \uc0dd\uc131\ud574\uc8fc\ub294 \ub3c4\uad6c\uc778 Swagger\ub97c \uc0ac\uc6a9\ud558\uc5ec \ubb38\uc11c\ud654\ud558\ub294 \ubc29\ubc95\uc744 \uc124\uba85\ud558\uaca0\uc2b5\ub2c8\ub2e4.<\/p>\n

1. Express \ubc0f Swagger \uc18c\uac1c<\/h2>\n

Express\ub294 \uc218\ub9ce\uc740 \ubbf8\ub4e4\uc6e8\uc5b4\uc640 \ud568\uaed8 \uc0ac\uc6a9\ub418\uc5b4 \ub6f0\uc5b4\ub09c \uc720\uc5f0\uc131\uc744 \uc81c\uacf5\ud569\ub2c8\ub2e4. Swagger\ub294 API \uba85\uc138\uc11c\ub97c \uc790\ub3d9\uc73c\ub85c \uc0dd\uc131\ud574\uc8fc\ub294 \ub3c4\uad6c\ub85c, API \uac1c\ubc1c \uacfc\uc815\uc5d0\uc11c\uc758 \ubb38\uc11c\ud654 \ubc0f \ud14c\uc2a4\ud2b8\ub97c \ub9e4\uc6b0 \uac04\ud3b8\ud558\uac8c \ub9cc\ub4e4\uc5b4\uc90d\ub2c8\ub2e4.<\/p>\n

1.1 Express\ub780?<\/h3>\n

Express\ub294 \uc11c\ubc84 \uc0ac\uc774\ub4dc \uc560\ud50c\ub9ac\ucf00\uc774\uc158 \uad6c\ucd95\uc744 \uc704\ud55c \uac04\ub2e8\ud55c API\ub97c \uc81c\uacf5\ud558\ub294 \uc6f9 \ud504\ub808\uc784\uc6cc\ud06c\uc785\ub2c8\ub2e4. \ub77c\uc6b0\ud130, \ubbf8\ub4e4\uc6e8\uc5b4, HTTP \uc694\uccad \ubc0f \uc751\ub2f5 \ucc98\ub9ac \uae30\ub2a5\uc774 \ud3ec\ud568\ub418\uc5b4 \uc788\uc5b4 RESTful API \uac1c\ubc1c\uc5d0 \ud2b9\ud788 \uc801\ud569\ud569\ub2c8\ub2e4.<\/p>\n

1.2 Swagger\ub780?<\/h3>\n

Swagger\ub294 API\ub97c \uc815\uc758\ud558\uace0 \ubb38\uc11c\ud654\ud558\ub294 \ub370 \ub3c4\uc6c0\uc744 \uc8fc\ub294 \ub3c4\uad6c\uc785\ub2c8\ub2e4. Swagger\uc758 \uc8fc\uc694 \uc774\uc810\uc740 API \ubb38\uc11c\ub97c \ub3d9\uc801\uc73c\ub85c \uc0dd\uc131\ud558\uace0, \uc0ac\uc6a9\uc790\uac00 API\ub97c \ud14c\uc2a4\ud2b8\ud560 \uc218 \uc788\ub294 UI\ub97c \uc81c\uacf5\ud55c\ub2e4\ub294 \uc810\uc785\ub2c8\ub2e4.<\/p>\n

2. \uac1c\ubc1c \ud658\uacbd \uc124\uc815<\/h2>\n

\uc774\uc81c Express\uc640 Swagger\ub97c \uc124\uc815\ud558\ub294 \ubc29\ubc95\uc5d0 \ub300\ud574 \uc54c\uc544\ubcf4\uaca0\uc2b5\ub2c8\ub2e4. \uc544\ub798\uc758 \ub2e8\uacc4\ub97c \ub530\ub77c \ud574\ubcf4\uc138\uc694.<\/p>\n

2.1 Node.js \ubc0f npm \uc124\uce58<\/h3>\n

Node.js\uac00 \uc124\uce58\ub418\uc5b4 \uc788\uc9c0 \uc54a\uc740 \uacbd\uc6b0 [Node.js \uacf5\uc2dd \uc6f9\uc0ac\uc774\ud2b8](https:\/\/nodejs.org\/)\uc5d0\uc11c \uc124\uce58\ud569\ub2c8\ub2e4. \uc124\uce58\uac00 \uc644\ub8cc\ub418\uba74, \ub2e4\uc74c \uba85\ub839\uc5b4\ub85c Node.js\uc640 npm\uc774 \uc815\uc0c1\uc801\uc73c\ub85c \uc124\uce58\ub418\uc5c8\ub294\uc9c0 \ud655\uc778\ud569\ub2c8\ub2e4:<\/p>\n

node -v\nnpm -v<\/code><\/pre>\n
2.2 \ud504\ub85c\uc81d\ud2b8 \ud3f4\ub354 \uc0dd\uc131 \ubc0f \ucd08\uae30\ud654<\/h3>\n
\ud504\ub85c\uc81d\ud2b8\ub97c \uc9c4\ud589\ud560 \ud3f4\ub354\ub97c \uc0dd\uc131\ud558\uace0 npm\uc744 \uc0ac\uc6a9\ud558\uc5ec \ucd08\uae30\ud654\ud569\ub2c8\ub2e4:<\/p>\n
mkdir express-swagger-example\ncd express-swagger-example\nnpm init -y<\/code><\/pre>\n
2.3 Express \uc124\uce58<\/h3>\n
\ub2e4\uc74c \uba85\ub839\uc5b4\ub85c Express\ub97c \uc124\uce58\ud569\ub2c8\ub2e4:<\/p>\n
npm install express<\/code><\/pre>\n
2.4 Swagger \uad00\ub828 \ud328\ud0a4\uc9c0 \uc124\uce58<\/h3>\n
Swagger UI\uc640 Swagger-jsdoc\uc744 \uc124\uce58\ud569\ub2c8\ub2e4. Swagger UI\ub294 API \ubb38\uc11c\ub97c \uc2dc\uac01\ud654\ud558\uc5ec \ubcf4\uc5ec\uc8fc\ub294 \uc5ed\ud560\uc744 \ud558\uace0, Swagger-jsdoc\uc740 JSDoc \uc2a4\ud0c0\uc77c\ub85c API \ubb38\uc11c\ub97c \uc791\uc131\ud560 \uc218 \uc788\uac8c \ud574\uc90d\ub2c8\ub2e4:<\/p>\n
npm install swagger-ui-express swagger-jsdoc<\/code><\/pre>\n
3. Express \uc560\ud50c\ub9ac\ucf00\uc774\uc158 \uc124\uc815<\/h2>\n
\uc774\uc81c \uae30\ubcf8\uc801\uc778 Express \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uc744 \uc124\uc815\ud574 \ubcf4\uaca0\uc2b5\ub2c8\ub2e4. index.js<\/code> \ud30c\uc77c\uc744 \uc0dd\uc131\ud558\uace0 \uc544\ub798\uc758 \ucf54\ub4dc\ub97c \uc785\ub825\ud558\uc138\uc694:<\/p>\n
const express = require('express');\nconst swaggerJsDoc = require('swagger-jsdoc');\nconst swaggerUi = require('swagger-ui-express');\n\nconst app = express();\nconst port = 3000;\n\n\/\/ Swagger \uc124\uc815\nconst swaggerOptions = {\n    swaggerDefinition: {\n        openapi: '3.0.0',\n        info: {\n            title: 'Express API Documentation',\n            version: '1.0.0',\n            description: '\uc790\ub3d9\ud654\ub41c \ubb38\uc11c\ud654 API \uc608\uc81c',\n        },\n        servers: [\n            {\n                url: `http:\/\/localhost:${port}`,\n            },\n        ],\n    },\n    apis: ['.\/routes\/*.js'], \/\/ API \ubb38\uc11c\ud654\ud560 \uacbd\ub85c\n};\n\nconst swaggerDocs = swaggerJsDoc(swaggerOptions);\napp.use('\/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));\n\n\/\/ \uae30\ubcf8 \ub77c\uc6b0\ud2b8 \uc608\uc81c\napp.get('\/', (req, res) => {\n    res.send('Hello World!');\n});\n\n\/\/ \uc11c\ubc84 \uc2dc\uc791\napp.listen(port, () => {\n    console.log(`Server is running on http:\/\/localhost:${port}`);\n});<\/code><\/pre>\n
3.1 Swagger \uc124\uc815 \uc124\uba85<\/h3>\n
\uc704 \ucf54\ub4dc\uc5d0\uc11c swaggerDefinition<\/code> \uac1d\uccb4\ub294 API \ubb38\uc11c\uc758 \uc815\ubcf4\ub97c \uc815\uc758\ud569\ub2c8\ub2e4. \uc5ec\uae30\uc5d0\ub294 API\uc758 \uc774\ub984, \ubc84\uc804, \uc124\uba85 \ubc0f \uc11c\ubc84 \uc815\ubcf4\ub97c \uc124\uc815\ud569\ub2c8\ub2e4. apis<\/code> \ubc30\uc5f4\uc740 Swagger\uac00 \ubb38\uc11c\ud654\ud560 API \ud30c\uc77c\uc758 \uacbd\ub85c\ub97c \uc9c0\uc815\ud569\ub2c8\ub2e4.<\/p>\n
3.2 \uae30\ubcf8 \ub77c\uc6b0\ud2b8 \ucd94\uac00<\/h3>\n
\uc608\uc81c\uc5d0\uc11c\ub294 \/<\/code> \uacbd\ub85c\uc5d0 \ub300\ud55c GET \uc694\uccad\uc744 \ucc98\ub9ac\ud558\ub294 \uae30\ubcf8 \ub77c\uc6b0\ud2b8\ub97c \ucd94\uac00\ud588\uc2b5\ub2c8\ub2e4. \uc774 \ub77c\uc6b0\ud2b8\uc5d0 \ub300\ud55c Swagger \ubb38\uc11c\ud654\ub3c4 \ucd94\uac00\ud574\ubcf4\uaca0\uc2b5\ub2c8\ub2e4.<\/p>\n
4. API \uacbd\ub85c \ubb38\uc11c\ud654<\/h2>\n
\ub2e4\uc74c\uc73c\ub85c, API \uacbd\ub85c\ub97c \ubb38\uc11c\ud654\ud560 \ud30c\uc77c\uc778 routes\/index.js<\/code> \ud30c\uc77c\uc744 \uc0dd\uc131\ud558\uace0 \uc544\ub798\uc758 \ucf54\ub4dc\ub97c \uc785\ub825\ud574 \ubcf4\uc138\uc694:<\/p>\n
\/**\n * @swagger\n * \/:\n *   get:\n *     summary: Hello World\ub97c \uc751\ub2f5\ud569\ub2c8\ub2e4.\n *     responses:\n *       200:\n *         description: \uc131\uacf5\uc801\uc73c\ub85c \uc751\ub2f5\n *\/\napp.get('\/', (req, res) => {\n    res.send('Hello World!');\n});<\/code><\/pre>\n
5. \uc11c\ubc84 \uc2e4\ud589 \ubc0f Swagger UI \ud655\uc778<\/h2>\n
\ubaa8\ub4e0 \uc124\uc815\uc774 \uc644\ub8cc\ub418\uc5c8\uc73c\uba74, \uc11c\ubc84\ub97c \uc2e4\ud589\ud569\ub2c8\ub2e4:<\/p>\n
node index.js<\/code><\/pre>\n
\ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c http:\/\/localhost:3000\/api-docs<\/a>\ub97c \uc5f4\uba74 Swagger UI\uac00 \ud45c\uc2dc\ub429\ub2c8\ub2e4. \uc774 UI\ub97c \ud1b5\ud574 API \ubb38\uc11c\uc640 \ud568\uaed8 `Hello World!` \uc751\ub2f5\uc744 \ud655\uc778\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
6. \ub2e4\uc591\ud55c API \ubb38\uc11c\ud654\ud558\uae30<\/h2>\n
\uc704\uc758 \uc608\uc81c\ub97c \ubc14\ud0d5\uc73c\ub85c, \ubcf4\ub2e4 \ubcf5\uc7a1\ud55c API\ub97c \ubb38\uc11c\ud654\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4. \uc608\ub97c \ub4e4\uc5b4, \uc0ac\uc6a9\uc790\uc758 CRUD(Create, Read, Update, Delete) \uc791\uc5c5\uc744 \uc9c0\uc6d0\ud558\ub294 API\ub97c \ubb38\uc11c\ud654\ud574 \ubcf4\uaca0\uc2b5\ub2c8\ub2e4.<\/p>\n
6.1 CRUD API \uc124\uc815<\/h3>\n
\uc544\ub798\uc758 \ucf54\ub4dc\ub97c routes\/user.js<\/code> \ud30c\uc77c\uc5d0 \ucd94\uac00\ud569\ub2c8\ub2e4:<\/p>\n
const express = require('express');\nconst router = express.Router();\n\n\/**\n * @swagger\n * \/users:\n *   get:\n *     summary: \uc0ac\uc6a9\uc790 \ubaa9\ub85d\uc744 \uac00\uc838\uc635\ub2c8\ub2e4.\n *     responses:\n *       200:\n *         description: \uc131\uacf5\uc801\uc73c\ub85c \uc0ac\uc6a9\uc790 \ubaa9\ub85d\uc744 \ubc18\ud658\ud569\ub2c8\ub2e4.\n *\/\nrouter.get('\/', (req, res) => {\n    res.send('\uc0ac\uc6a9\uc790 \ubaa9\ub85d');\n});\n\n\/**\n * @swagger\n * \/users:\n *   post:\n *     summary: \uc0c8 \uc0ac\uc6a9\uc790\ub97c \uc0dd\uc131\ud569\ub2c8\ub2e4.\n *     requestBody:\n *       required: true\n *       content:\n *         application\/json:\n *           schema:\n *             type: object\n *             properties:\n *               name:\n *                 type: string\n *               age:\n *                 type: integer\n *     responses:\n *       201:\n *         description: \uc131\uacf5\uc801\uc73c\ub85c \uc0ac\uc6a9\uc790 \uc0dd\uc131\n *\/\nrouter.post('\/', (req, res) => {\n    res.status(201).send('\uc0ac\uc6a9\uc790 \uc0dd\uc131\ub428');\n});\n\n\/**\n * @swagger\n * \/users\/{id}:\n *   get:\n *     summary: \ud2b9\uc815 \uc0ac\uc6a9\uc790\uc758 \uc815\ubcf4\ub97c \uac00\uc838\uc635\ub2c8\ub2e4.\n *     parameters:\n *       - in: path\n *         name: id\n *         required: true\n *         description: \uc0ac\uc6a9\uc790 ID\n *         schema:\n *           type: integer\n *     responses:\n *       200:\n *         description: \uc0ac\uc6a9\uc790 \uc815\ubcf4 \ubc18\ud658\n *\/\nrouter.get('\/:id', (req, res) => {\n    res.send(`\uc0ac\uc6a9\uc790 ID: ${req.params.id}`);\n});\n\n\/**\n * @swagger\n * \/users\/{id}:\n *   put:\n *     summary: \ud2b9\uc815 \uc0ac\uc6a9\uc790\uc758 \uc815\ubcf4\ub97c \uc5c5\ub370\uc774\ud2b8\ud569\ub2c8\ub2e4.\n *     parameters:\n *       - in: path\n *         name: id\n *         required: true\n *         description: \uc0ac\uc6a9\uc790 ID\n *         schema:\n *           type: integer\n *     responses:\n *       200:\n *         description: \uc0ac\uc6a9\uc790 \uc815\ubcf4 \uc5c5\ub370\uc774\ud2b8 \uc131\uacf5\n *\/\nrouter.put('\/:id', (req, res) => {\n    res.send(`\uc0ac\uc6a9\uc790 ID: ${req.params.id} \uc815\ubcf4 \uc5c5\ub370\uc774\ud2b8\ub428`);\n});\n\n\/**\n * @swagger\n * \/users\/{id}:\n *   delete:\n *     summary: \ud2b9\uc815 \uc0ac\uc6a9\uc790\ub97c \uc0ad\uc81c\ud569\ub2c8\ub2e4.\n *     parameters:\n *       - in: path\n *         name: id\n *         required: true\n *         description: \uc0ac\uc6a9\uc790 ID\n *         schema:\n *           type: integer\n *     responses:\n *       204:\n *         description: \uc0ac\uc6a9\uc790 \uc0ad\uc81c \uc131\uacf5\n *\/\nrouter.delete('\/:id', (req, res) => {\n    res.status(204).send();\n});\n\nmodule.exports = router;<\/code><\/pre>\n
6.2 \ub77c\uc6b0\ud130\uc5d0 \uc0ac\uc6a9\uc790 \ub77c\uc6b0\ud2b8 \ucd94\uac00<\/h3>\n
\uc704\uc5d0\uc11c \uc0dd\uc131\ud55c \uc0ac\uc6a9\uc790 \ub77c\uc6b0\ud2b8\ub97c \uba54\uc778 \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uc5d0 \ucd94\uac00\ud574\uc57c \ud569\ub2c8\ub2e4. index.js<\/code> \ud30c\uc77c\uc744 \uc218\uc815\ud558\uace0 \uc0ac\uc6a9\uc790 \ub77c\uc6b0\ud130\ub97c \ub4f1\ub85d\ud569\ub2c8\ub2e4:<\/p>\n
const userRouter = require('.\/routes\/user');\napp.use('\/users', userRouter);<\/code><\/pre>\n
7. API \ubb38\uc11c \ud655\uc778<\/h2>\n
\uc11c\ubc84\ub97c \ub2e4\uc2dc \uc2e4\ud589\ud55c \ub2e4\uc74c, Swagger UI\ub97c \ubc29\ubb38\ud558\uc5ec \/users<\/code>\uc5d0 \ub300\ud55c \ub2e4\uc591\ud55c API\uc5d0 \ub300\ud55c \ubb38\uc11c\ub97c \ud655\uc778\ud569\ub2c8\ub2e4. \uc774\ub97c \ud1b5\ud574 \uc0ac\uc6a9\uc790 \ubaa9\ub85d \uc870\ud68c, \uc0dd\uc131, \uc870\ud68c, \uc5c5\ub370\uc774\ud2b8 \ubc0f \uc0ad\uc81c\uc640 \uac19\uc740 \uae30\ub2a5\uc744 \ud655\uc778\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
8. \ubcf4\uc548 \ubc0f \uae30\ud0c0 \uc124\uc815<\/h2>\n
\uc0dd\uc131\ud55c API\ub97c \uc6b4\uc601\ud560 \ub54c\ub294 \ubcf4\uc548 \ubc29\ubc95\ub860 \ub610\ud55c \uace0\ub824\ud574\uc57c \ud569\ub2c8\ub2e4. JWT(Json Web Token) \uc778\uc99d \ubc29\uc2dd\uc744 \ud1b5\ud574 \uc0ac\uc6a9\uc790\ub97c \uc778\uc99d\ud558\uace0 API\uc5d0 \uc811\uadfc\ud560 \uc218 \uc788\ub3c4\ub85d \uc124\uc815\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4. \ub610\ud55c, Express\uc758 \ubbf8\ub4e4\uc6e8\uc5b4\ub97c \ud1b5\ud574 \uc694\uccad\uc744 \ub85c\uae45\ud558\uac70\ub098 \uc5d0\ub7ec \ud578\ub4e4\ub9c1\uc744 \ucd94\uac00\ud558\ub294 \uac83\ub3c4 \uc88b\uc740 \ubc29\ubc95\uc785\ub2c8\ub2e4.<\/p>\n
9. \ub9c8\ubb34\ub9ac<\/h2>\n
\uc774\ubc88 \uae00\uc5d0\uc11c\ub294 Express \uc11c\ubc84\ub97c \uc124\uc815\ud558\uace0 Swagger\ub97c \ud65c\uc6a9\ud558\uc5ec \uc790\ub3d9\uc73c\ub85c API \ubb38\uc11c\ub97c \uc0dd\uc131\ud558\ub294 \ubc29\ubc95\uc5d0 \ub300\ud574 \uc54c\uc544\ubcf4\uc558\uc2b5\ub2c8\ub2e4. \ubb38\uc11c\ud654\ub294 \uac1c\ubc1c\uc758 \uc911\uc694\ud55c \ubd80\ubd84 \uc911 \ud558\ub098\uc774\uba70, Swagger\uc640 \uac19\uc740 \ub3c4\uad6c\ub97c \ud65c\uc6a9\ud558\uc5ec \uc774\ub97c \uc27d\uac8c \ucc98\ub9ac\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4. \uc774\ub7ec\ud55c \ub3c4\uad6c\ub97c \uc801\uadf9 \ud65c\uc6a9\ud558\uc5ec \ub354 \ub098\uc740 API \uac1c\ubc1c \ud658\uacbd\uc744 \ub9cc\ub4e4\uc5b4 \ubcf4\uc2dc\uae30 \ubc14\ub78d\ub2c8\ub2e4.<\/p>\n
\ucd94\uac00\uc801\uc73c\ub85c, Swagger\ub97c \uc0ac\uc6a9\ud558\uc5ec \ub9cc\ub4e4\uc5b4\uc9c4 UI\ub294 API \uc18c\ube44\uc790\uc5d0\uac8c \uc720\uc6a9\ud55c \uc815\ubcf4\ub97c \uc81c\uacf5\ud558\uba70, \ud14c\uc2a4\ud2b8\ub97c \uc9c1\uc811 \ud574\ubcfc \uc218 \uc788\ub294 \uae30\ub2a5\ub3c4 \uc81c\uacf5\ud569\ub2c8\ub2e4. \ub610\ud55c, API \ub3c4\uba54\uc778\uc5d0 \ud3ec\ud568\ub41c \ubaa8\ub4e0 \uc5d4\ub4dc\ud3ec\uc778\ud2b8\ub97c \uc27d\uac8c \ud0d0\uc0c9\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
10. \ucc38\uace0 \uc790\ub8cc<\/h2>\n