{"id":38390,"date":"2024-11-01T17:18:08","date_gmt":"2024-11-01T17:18:08","guid":{"rendered":"http:\/\/atmokpo.com\/w\/?p=38390"},"modified":"2024-11-26T06:44:27","modified_gmt":"2024-11-26T06:44:27","slug":"express-%ea%b0%9c%eb%b0%9c-%ea%b0%95%ec%a2%8c-swagger-%eb%98%90%eb%8a%94-postman%ec%9d%84-%ec%9d%b4%ec%9a%a9%ed%95%9c-api-%eb%ac%b8%ec%84%9c%ed%99%94","status":"publish","type":"post","link":"https:\/\/atmokpo.com\/w\/38390\/","title":{"rendered":"Express \uac1c\ubc1c \uac15\uc88c, Swagger \ub610\ub294 Postman\uc744 \uc774\uc6a9\ud55c API \ubb38\uc11c\ud654"},"content":{"rendered":"

<\/p>\n

\uc6f9 \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uc5d0\uc11c API\ub294 \uc911\uc694\ud55c \uc5ed\ud560\uc744 \ud569\ub2c8\ub2e4. \ud2b9\ud788, \ubc31\uc5d4\ub4dc \uac1c\ubc1c\uc5d0\uc11c\ub294 API\ub97c \ud1b5\ud574 \ud074\ub77c\uc774\uc5b8\ud2b8\uc640 \uc11c\ubc84 \uac04\uc758 \ud1b5\uc2e0\uc744 \uc6d0\ud65c\ud558\uac8c \uc774\ub8e8\uc5b4\uc9c8 \uc218 \uc788\uac8c \ud569\ub2c8\ub2e4. \ub530\ub77c\uc11c, API \ubb38\uc11c\ud654\ub294 \ud300\uc6d0 \uac04\uc758 \uc774\ud574\ub97c \ub192\uc774\uace0, \uc720\uc9c0 \ubcf4\uc218\ub97c \uc6a9\uc774\ud558\uac8c \ud558\ub294 \uc911\uc694\ud55c \uc791\uc5c5\uc785\ub2c8\ub2e4. \uc624\ub298\uc740 Express.js \ubc31\uc5d4\ub4dc \uc11c\ubc84\ub97c \uac1c\ubc1c\ud558\uba70 Swagger\uc640 Postman\uc744 \uc774\uc6a9\ud574 API \ubb38\uc11c\ud654\ud558\ub294 \ubc29\ubc95\uc5d0 \ub300\ud574 \uc54c\uc544\ubcf4\uaca0\uc2b5\ub2c8\ub2e4.<\/p>\n

1. Express.js \uc18c\uac1c<\/h2>\n

Express.js\ub294 Node.js\ub97c \uc704\ud55c \ucd5c\uc18c\ud654\ub41c \uc6f9 \ud504\ub808\uc784\uc6cc\ud06c\ub85c, \uc6f9 \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uacfc APIs\ub97c \uac1c\ubc1c\ud558\ub294 \ub370 \uc0ac\uc6a9\ub429\ub2c8\ub2e4. Express\ub294 \ub2e4\uc591\ud55c \ubbf8\ub4e4\uc6e8\uc5b4\uc640 \ub77c\uc6b0\ud305 \uae30\ub2a5\uc744 \uc81c\uacf5\ud558\uc5ec \uac1c\ubc1c\uc790\uac00 \ud6a8\uc728\uc801\uc73c\ub85c \uc6f9 \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uc744 \uad6c\ucd95\ud560 \uc218 \uc788\ub3c4\ub85d \ub3c4\uc640\uc90d\ub2c8\ub2e4.<\/p>\n

2. Express \ud504\ub85c\uc81d\ud2b8 \uc124\uc815<\/h2>\n
bash\n# Express \ud504\ub85c\uc81d\ud2b8 \uc0dd\uc131\nmkdir express-api-demo\ncd express-api-demo\nnpm init -y\nnpm install express\n<\/code><\/pre>\n
\uc704 \uba85\ub839\uc5b4\ub97c \uc0ac\uc6a9\ud558\uc5ec Express \ud504\ub85c\uc81d\ud2b8\ub97c \uc0dd\uc131\ud558\uace0, Express.js \ud328\ud0a4\uc9c0\ub97c \uc124\uce58\ud569\ub2c8\ub2e4.<\/p>\n
2.1 \uae30\ubcf8 \uc11c\ubc84 \uc124\uc815<\/h3>\n
javascript\nconst express = require('express');\nconst app = express();\nconst PORT = 3000;\n\napp.get('\/', (req, res) => {\n    res.send('Hello, Express!');\n});\n\napp.listen(PORT, () => {\n    console.log(`Server is running on http:\/\/localhost:${PORT}`);\n});\n<\/code><\/pre>\n
\uc774\uc81c \uae30\ubcf8 Express \uc11c\ubc84\uac00 \uc124\uc815\ub418\uc5c8\uc2b5\ub2c8\ub2e4. npm start<\/code>\ub85c \uc11c\ubc84\ub97c \uc2e4\ud589\ud558\uba74 http:\/\/localhost:3000<\/code>\uc5d0\uc11c “Hello, Express!” \uba54\uc2dc\uc9c0\ub97c \ubcfc \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
3. Swagger\ub97c \uc774\uc6a9\ud55c API \ubb38\uc11c\ud654<\/h2>\n
Swagger\ub294 RESTful API\uc758 \uc124\uacc4, \ubb38\uc11c\ud654 \ubc0f \ud14c\uc2a4\ud2b8\ub97c \uc704\ud55c \ud1b5\ud569 \uc194\ub8e8\uc158\uc785\ub2c8\ub2e4. Swagger UI\ub294 API\ub97c \uc2dc\uac01\uc801\uc73c\ub85c \ud45c\ud604\ud558\uc5ec \uac1c\ubc1c\uc790\uc640 \ube44\uac1c\ubc1c\uc790\uac00 \uc27d\uac8c \uc774\ud574\ud560 \uc218 \uc788\ub3c4\ub85d \ub3c4\uc640\uc90d\ub2c8\ub2e4. \uc774\uc81c Swagger\ub97c Express \ud504\ub85c\uc81d\ud2b8\uc5d0 \ud1b5\ud569\ud558\ub294 \ubc29\ubc95\uc744 \uc0b4\ud3b4\ubcf4\uaca0\uc2b5\ub2c8\ub2e4.<\/p>\n
3.1 Swagger UI\uc640 Swagger JSDoc \uc124\uce58<\/h3>\n
bash\nnpm install swagger-ui-express swagger-jsdoc\n<\/code><\/pre>\n
3.2 Swagger \uc124\uc815<\/h3>\n
Swagger\ub97c \uc124\uc815\ud558\uae30 \uc704\ud574 \uc544\ub798\uc640 \uac19\uc774 \ucf54\ub4dc\ub97c \uc218\uc815\ud569\ub2c8\ub2e4.<\/p>\n
javascript\nconst swaggerJsDoc = require('swagger-jsdoc');\nconst swaggerUi = require('swagger-ui-express');\n\nconst swaggerOptions = {\n    swaggerDefinition: {\n        openapi: '3.0.0',\n        info: {\n            title: 'Express API Demo',\n            version: '1.0.0',\n            description: 'API documentation for Express Demo',\n        },\n        servers: [\n            {\n                url: 'http:\/\/localhost:3000',\n            },\n        ],\n    },\n    apis: ['.\/routes\/*.js'], \/\/ API \ubb38\uc11c\ud654\ud560 \ud30c\uc77c \uacbd\ub85c\n};\n\nconst swaggerDocs = swaggerJsDoc(swaggerOptions);\napp.use('\/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));\n<\/code><\/pre>\n
3.3 API \ubb38\uc11c\ud654 \uc8fc\uc11d \ucd94\uac00<\/h3>\n
Swagger\uc5d0\uc11c API\ub97c \ubb38\uc11c\ud654\ud558\uae30 \uc704\ud574 \uac01 API \ud568\uc218 \uc704\uc5d0 JSDoc \uc8fc\uc11d\uc744 \ucd94\uac00\ud574\uc57c \ud569\ub2c8\ub2e4. \ub2e4\uc74c\uc740 \uac04\ub2e8\ud55c GET API\uc5d0 \ub300\ud55c \uc608\uc785\ub2c8\ub2e4.<\/p>\n
javascript\n\/**\n * @swagger\n * \/:\n *   get:\n *     summary: Returns a Hello message\n *     responses:\n *       200:\n *         description: A Hello message\n *\/\napp.get('\/', (req, res) => {\n    res.send('Hello, Express!');\n});\n<\/code><\/pre>\n
\uc774\uc81c \uc11c\ubc84\ub97c \ub2e4\uc2dc \uc2e4\ud589\ud558\uace0 http:\/\/localhost:3000\/api-docs<\/code>\ub85c \uc774\ub3d9\ud558\uba74 Swagger UI\ub97c \ud1b5\ud574 API \ubb38\uc11c\ub97c \ud655\uc778\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
4. Postman\uc744 \uc774\uc6a9\ud55c API \ud14c\uc2a4\ud2b8 \ubc0f \ubb38\uc11c\ud654<\/h2>\n
Postman\uc740 API\ub97c \ud14c\uc2a4\ud2b8\ud558\uace0 \ubb38\uc11c\ud654\ud558\ub294 \ub370 \ub110\ub9ac \uc0ac\uc6a9\ub418\ub294 \ub3c4\uad6c\uc785\ub2c8\ub2e4. Postman\uc744 \uc0ac\uc6a9\ud558\uc5ec API\ub97c \uc27d\uac8c \ud14c\uc2a4\ud2b8\ud558\uace0, \ud14c\uc2a4\ud2b8 \uacb0\uacfc\ub97c \ubb38\uc11c\ud654\ud558\ub294 \ubc29\ubc95\uc744 \uc54c\uc544\ubcf4\uaca0\uc2b5\ub2c8\ub2e4.<\/p>\n
4.1 Postman \uc124\uce58<\/h3>\n
Postman\uc740 \uacf5\uc2dd \uc6f9\uc0ac\uc774\ud2b8\uc5d0\uc11c \ub2e4\uc6b4\ubc1b\uc544 \uc124\uce58\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4. \uc124\uce58 \ud6c4 \uc560\ud50c\ub9ac\ucf00\uc774\uc158\uc744 \uc5f4\uace0 API \uc694\uccad\uc744 \uc0dd\uc131\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
4.2 API \uc694\uccad \ub9cc\ub4e4\uae30<\/h3>\n
Postman\uc5d0\uc11c \uc0c8 \uc694\uccad\uc744 \ub9cc\ub4e4\uace0, HTTP \uba54\uc11c\ub4dc\uc640 URL\uc744 \uc785\ub825\ud558\uc5ec API \uc694\uccad\uc744 \uad6c\uc131\ud569\ub2c8\ub2e4. \uc544\ub798\ub294 GET \uc694\uccad\uc758 \uc608\uc785\ub2c8\ub2e4.<\/p>\n
plaintext\nMethod: GET\nURL: http:\/\/localhost:3000\/\n<\/code><\/pre>\n
4.3 \uc694\uccad \ud14c\uc2a4\ud2b8 \ubc0f \uc751\ub2f5 \ud655\uc778<\/h3>\n
\uc704\uc640 \uac19\uc774 \uc694\uccad\uc744 \uad6c\uc131\ud55c \ud6c4, Send<\/code> \ubc84\ud2bc\uc744 \ud074\ub9ad\ud558\uc5ec \uc694\uccad\uc744 \uc804\uc1a1\ud569\ub2c8\ub2e4. \uc62c\ubc14\ub974\ub2e4\uba74 “Hello, Express!”\ub77c\ub294 \uc751\ub2f5\uc744 \ud655\uc778\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
4.4 API \ubb38\uc11c\ud654<\/h3>\n
Postman\uc740 \uc694\uccad\uc774 \uc131\uacf5\uc801\uc73c\ub85c \uc644\ub8cc\ub41c \ud6c4, \uc694\uccad \uc815\ubcf4\ub97c \ubb38\uc11c\ud654\ud560 \uc218 \uc788\ub294 \uae30\ub2a5\uc744 \uc81c\uacf5\ud569\ub2c8\ub2e4. \uc694\uccad\uc744 \uc120\ud0dd\ud55c \ub4a4 \uc6b0\uce21 \uc0c1\ub2e8\uc758 ...<\/code> \uba54\ub274\uc5d0\uc11c Save as Template<\/code>\uc744 \uc120\ud0dd\ud558\uc5ec \uc694\uccad \uc815\ubcf4\ub97c \uc800\uc7a5\ud560 \uc218 \uc788\uc2b5\ub2c8\ub2e4.<\/p>\n
5. API \ubb38\uc11c\ud654\uc758 \uc911\uc694\uc131<\/h2>\n
API \ubb38\uc11c\ud654\ub294 \uac1c\ubc1c\uc790\uc758 \uc0dd\uc0b0\uc131\uc744 \ub192\uc774\uace0, \uc720\uc9c0 \ubcf4\uc218\ub97c \uc6a9\uc774\ud558\uac8c \ub9cc\ub4e4\uba70, \ud300\uacfc\uc758 \ud611\uc5c5\uc744 \ucd09\uc9c4\ud569\ub2c8\ub2e4. Swagger\uc640 Postman\uc740 \uc774\ub7ec\ud55c \ubb38\uc11c\ud654 \uacfc\uc815\uc744 \uac04\uc18c\ud654\ud574\uc8fc\uba70, \ud300\uc6d0\ub4e4\uc774 API\uc758 \uc791\ub3d9 \ubc29\uc2dd\uc744 \uc27d\uac8c \uc774\ud574\ud560 \uc218 \uc788\ub3c4\ub85d \ub3c4\uc640\uc90d\ub2c8\ub2e4.<\/p>\n
6. \uacb0\ub860<\/h2>\n
\uc624\ub298 \uc6b0\ub9ac\ub294 Express.js\ub97c \uc0ac\uc6a9\ud55c \uac04\ub2e8\ud55c API \uc11c\ubc84\ub97c \uc124\uc815\ud558\uace0, Swagger\uc640 Postman\uc744 \ud1b5\ud574 API\ub97c \ubb38\uc11c\ud654\ud558\ub294 \ubc29\ubc95\uc744 \uc54c\uc544\ubcf4\uc558\uc2b5\ub2c8\ub2e4. \uc774 \uacfc\uc815\uc5d0\uc11c \uc5bb\uc740 \uc9c0\uc2dd\uc744 \ubc14\ud0d5\uc73c\ub85c, \uc55e\uc73c\ub85c \ub354\uc6b1 \ud6a8\uc728\uc801\uc73c\ub85c API\ub97c \uac1c\ubc1c\ud558\uace0 \ubb38\uc11c\ud654\ud560 \uc218 \uc788\uae30\ub97c \ubc14\ub78d\ub2c8\ub2e4.<\/p>\n
\ucc38\uace0 \uc790\ub8cc<\/h3>\n