{"id":2652,"date":"2026-10-24T08:46:52","date_gmt":"2026-10-24T08:46:52","guid":{"rendered":"https:\/\/wayhope.kro.kr\/?p=2652"},"modified":"2026-10-24T08:46:52","modified_gmt":"2026-10-24T08:46:52","slug":"api-%eb%aa%85%ec%84%b8-%ec%84%a4%ea%b3%84%ec%99%80-%ec%9e%90%eb%8f%99%ed%99%94-swagger-openapi","status":"publish","type":"post","link":"https:\/\/wayhope.kro.kr\/?p=2652","title":{"rendered":"API \uba85\uc138 \uc124\uacc4\uc640 \uc790\ub3d9\ud654 #Swagger #OpenAPI"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\">Swagger\uc640 OpenAPI\ub780?<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">\ubc31\uc5d4\ub4dc \uc11c\ubc84\ub97c \uac1c\ubc1c\ud560 \ub54c API\ub97c \uad6c\ud604\ud558\ub294 \uac83\ub9cc\ud07c \uc911\uc694\ud55c \uc791\uc5c5\uc774 API\uc758 \uaddc\uaca9\uc744 \uc815\uc758\ud558\uace0 \uacf5\uc720\ud558\ub294 \uac83\uc774\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ud074\ub77c\uc774\uc5b8\ud2b8 \uac1c\ubc1c\uc790\ub294 \uc11c\ubc84\uc5d0 \uc5b4\ub5a4 URL\ub85c \uc694\uccad\ud574\uc57c \ud558\ub294\uc9c0, \uc5b4\ub5a4 \ub370\uc774\ud130\ub97c \uc804\ub2ec\ud574\uc57c \ud558\ub294\uc9c0, \uc5b4\ub5a4 \uc751\ub2f5\uc744 \ubc1b\uc744 \uc218 \uc788\ub294\uc9c0 \uc54c\uc544\uc57c \ud55c\ub2e4. \uc11c\ubc84 \uac1c\ubc1c\uc790 \uc5ed\uc2dc API\uc758 \uc785\ub825\uac12, \uc751\ub2f5 \ud615\uc2dd, \uc778\uc99d \ubc29\uc2dd, \uc624\ub958 \ucf54\ub4dc\ub97c \uc77c\uad00\ub418\uac8c \uad00\ub9ac\ud574\uc57c \ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774\ub7ec\ud55c API\uc758 \uaddc\uaca9\uc744 \uc815\uc758\ud558\ub294 \ud45c\uc900\uc774 <strong>OpenAPI<\/strong>\uc774\uba70, \uc774\ub97c \uc2dc\uac01\ud654\ud558\uace0 \ud3b8\uc9d1\ud558\uac70\ub098 \ud65c\uc6a9\ud558\ub294 \ub3c4\uad6c\uac00 <strong>Swagger<\/strong>\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">OpenAPI\uc640 Swagger\uc758 \ucc28\uc774<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><tbody><tr><th>\uad6c\ubd84<\/th><th>\uc124\uba85<\/th><\/tr><tr><td>OpenAPI Specification<\/td><td>REST API\uc758 \uad6c\uc870\uc640 \ub3d9\uc791\uc744 \uc815\uc758\ud558\ub294 \uba85\uc138 \ud45c\uc900<\/td><\/tr><tr><td>Swagger UI<\/td><td>OpenAPI \uba85\uc138\ub97c \uae30\ubc18\uc73c\ub85c API \ubb38\uc11c\ub97c \uc2dc\uac01\ud654\ud558\uace0 \ud14c\uc2a4\ud2b8\ud558\ub294 \ub3c4\uad6c<\/td><\/tr><tr><td>Swagger Editor<\/td><td>OpenAPI \uba85\uc138\ub97c \uc791\uc131\ud558\uace0 \uac80\uc99d\ud558\ub294 \ud3b8\uc9d1 \ub3c4\uad6c<\/td><\/tr><tr><td>Swagger Codegen<\/td><td>\uba85\uc138\ub97c \uae30\ubc18\uc73c\ub85c \ud074\ub77c\uc774\uc5b8\ud2b8 SDK\ub098 \uc11c\ubc84 \ucf54\ub4dc\ub97c \uc0dd\uc131\ud558\ub294 \ub3c4\uad6c<\/td><\/tr><tr><td>OpenAPI Generator<\/td><td>\ub2e4\uc591\ud55c \uc5b8\uc5b4\uc640 \ud504\ub808\uc784\uc6cc\ud06c\ub97c \ub300\uc0c1\uc73c\ub85c \ucf54\ub4dc\ub97c \uc0dd\uc131\ud558\ub294 \ub3c4\uad6c<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\">OpenAPI\ub294 API\uc758 \uacc4\uc57d\uc744 \uc815\uc758\ud558\uace0, Swagger \ub3c4\uad6c\ub294 \ud574\ub2f9 \uacc4\uc57d\uc744 \uc791\uc131\ud558\uac70\ub098 \ud655\uc778\ud558\uace0 \ud65c\uc6a9\ud560 \uc218 \uc788\ub3c4\ub85d \uc9c0\uc6d0\ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc608\ub97c \ub4e4\uc5b4 \uac8c\uc784 \uc11c\ubc84\uc5d0\uc11c \ub2e4\uc74c\uacfc \uac19\uc740 API\ub97c \uc81c\uacf5\ud55c\ub2e4\uace0 \uac00\uc815\ud558\uc790.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>POST \/users<\/code>: \uc0ac\uc6a9\uc790 \uc0dd\uc131<\/li>\n\n\n\n<li><code>GET \/users\/{userId}<\/code>: \uc0ac\uc6a9\uc790 \uc870\ud68c<\/li>\n\n\n\n<li><code>PATCH \/users\/{userId}<\/code>: \uc0ac\uc6a9\uc790 \uc815\ubcf4 \uc218\uc815<\/li>\n\n\n\n<li><code>DELETE \/users\/{userId}<\/code>: \uc0ac\uc6a9\uc790 \uc0ad\uc81c<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774 API\ub4e4\uc758 \uc694\uccad \ud615\uc2dd, \uc751\ub2f5 \ub370\uc774\ud130, \uc778\uc99d \uc694\uad6c \uc0ac\ud56d, \uc624\ub958 \uc751\ub2f5 \ub4f1\uc744 OpenAPI \uba85\uc138\ub85c \uc815\uc758\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774\ub807\uac8c \uc791\uc131\ub41c \uba85\uc138\ub294 \ud504\ub860\ud2b8\uc5d4\ub4dc \uac1c\ubc1c\uc790\uc640 \ubc31\uc5d4\ub4dc \uac1c\ubc1c\uc790\uac00 \ub3d9\uc77c\ud55c API \uacc4\uc57d\uc744 \uae30\uc900\uc73c\ub85c \uc791\uc5c5\ud560 \uc218 \uc788\uac8c \ud574\uc900\ub2e4.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\">OpenAPI \uba85\uc138\uc758 \uae30\ubcf8 \uad6c\uc870<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">OpenAPI \uba85\uc138\ub294 \uc77c\ubc18\uc801\uc73c\ub85c YAML \ub610\ub294 JSON \ud615\uc2dd\uc73c\ub85c \uc791\uc131\ud55c\ub2e4. YAML\uc740 \ub4e4\uc5ec\uc4f0\uae30\ub97c \ud1b5\ud574 \uacc4\uce35 \uad6c\uc870\ub97c \ud45c\ud604\ud558\uae30 \ub54c\ubb38\uc5d0 \uc0ac\ub78c\uc774 \uc77d\uace0 \uc791\uc131\ud558\uae30 \ud3b8\ub9ac\ud558\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ub2e4\uc74c\uc740 OpenAPI 3.0 \uae30\ubc18\uc758 \uac04\ub2e8\ud55c \uc608\uc2dc\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>openapi: 3.0.3\n\ninfo:\n  title: Game Server API\n  description: \uac8c\uc784 \uc11c\ubc84 API \uba85\uc138\n  version: 1.0.0\n\nservers:\n  - url: https:\/\/api.example.com\n    description: Production Server\n\npaths:\n  \/users\/{userId}:\n    get:\n      summary: \uc0ac\uc6a9\uc790 \uc870\ud68c\n      operationId: getUser\n      parameters:\n        - name: userId\n          in: path\n          required: true\n          schema:\n            type: string\n\n      responses:\n        \"200\":\n          description: \uc0ac\uc6a9\uc790 \uc870\ud68c \uc131\uacf5\n        \"404\":\n          description: \uc0ac\uc6a9\uc790\ub97c \ucc3e\uc744 \uc218 \uc5c6\uc74c\n\ncomponents:\n  schemas:\n    User:\n      type: object\n      properties:\n        id:\n          type: string\n        nickname:\n          type: string<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uac01 \ud56d\ubaa9\uc758 \uc5ed\ud560\uc740 \ub2e4\uc74c\uacfc \uac19\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><code><strong>openapi<\/strong><\/code><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc0ac\uc6a9\ud558\ub294 OpenAPI \uba85\uc138 \ubc84\uc804\uc744 \uc9c0\uc815\ud55c\ub2e4. \uc5ec\uae30\uc11c\ub294 OpenAPI 3.0.3\uc744 \uc0ac\uc6a9\ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><code><strong>info<\/strong><\/code><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">API\uc758 \uc774\ub984, \uc124\uba85, \ubb38\uc11c \ubc84\uc804 \ub4f1\uc744 \uc815\uc758\ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><code><strong>servers<\/strong><\/code><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">API \uc694\uccad\uc744 \ubcf4\ub0bc \uc11c\ubc84\uc758 \uae30\ubcf8 URL\uc744 \uc815\uc758\ud55c\ub2e4. \uac1c\ubc1c \uc11c\ubc84\uc640 \uc6b4\uc601 \uc11c\ubc84\ub97c \uac01\uac01 \ub4f1\ub85d\ud560 \uc218\ub3c4 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><code><strong>paths<\/strong><\/code><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">API\uc758 \uacbd\ub85c\uc640 HTTP \uba54\uc11c\ub4dc, \uc694\uccad \ub9e4\uac1c\ubcc0\uc218, \uc751\ub2f5 \ub4f1\uc744 \uc815\uc758\ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><code><strong>components<\/strong><\/code><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc5ec\ub7ec API\uc5d0\uc11c \uacf5\ud1b5\uc73c\ub85c \uc0ac\uc6a9\ud558\ub294 \uc2a4\ud0a4\ub9c8, \uc751\ub2f5, \ub9e4\uac1c\ubcc0\uc218, \uc778\uc99d \ubc29\uc2dd\uc744 \uc815\uc758\ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774\ub7ec\ud55c \uad6c\uc870\ub97c \ud65c\uc6a9\ud558\uba74 API\uc758 \uc804\uccb4 \uacc4\uc57d\uc744 \ud558\ub098\uc758 \uba85\uc138\ub85c \uad00\ub9ac\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\">Paths\uc640 Operation \uc815\uc758<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">OpenAPI\uc5d0\uc11c <code>paths<\/code>\ub294 API\uc758 URL \uacbd\ub85c\ub97c \uc815\uc758\ud558\ub294 \ud575\uc2ec \uc601\uc5ed\uc774\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uac01 \uacbd\ub85c \uc544\ub798\uc5d0 HTTP \uba54\uc11c\ub4dc\ub97c \uc120\uc5b8\ud558\uace0, \ud574\ub2f9 \uc694\uccad\uc758 \ubaa9\uc801\uacfc \uc785\ub825\uac12, \ubc18\ud658\uac12\uc744 \uc815\uc758\ud55c\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>paths:\n  \/users:\n    post:\n      summary: \uc0ac\uc6a9\uc790 \uc0dd\uc131\n      operationId: createUser\n      tags:\n        - Users\n\n      requestBody:\n        required: true\n        content:\n          application\/json:\n            schema:\n              $ref: \"#\/components\/schemas\/CreateUserRequest\"\n\n      responses:\n        \"201\":\n          description: \uc0ac\uc6a9\uc790 \uc0dd\uc131 \uc131\uacf5\n          content:\n            application\/json:\n              schema:\n                $ref: \"#\/components\/schemas\/UserResponse\"<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc8fc\uc694 \uc18d\uc131\uc740 \ub2e4\uc74c\uacfc \uac19\ub2e4.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>summary<\/code>: API\uc758 \uac04\ub2e8\ud55c \uc124\uba85<\/li>\n\n\n\n<li><code>description<\/code>: API\uc758 \uc0c1\uc138\ud55c \uc124\uba85<\/li>\n\n\n\n<li><code>operationId<\/code>: API \uc791\uc5c5\uc744 \uc2dd\ubcc4\ud558\ub294 \uace0\uc720\ud55c \uc774\ub984<\/li>\n\n\n\n<li><code>tags<\/code>: API\ub97c \uae30\ub2a5\ubcc4\ub85c \uadf8\ub8f9\ud654\ud558\ub294 \ubd84\ub958<\/li>\n\n\n\n<li><code>requestBody<\/code>: \uc694\uccad \ubcf8\ubb38 \uc815\uc758<\/li>\n\n\n\n<li><code>parameters<\/code>: \uacbd\ub85c, \ucffc\ub9ac, \ud5e4\ub354 \ub4f1\uc758 \ub9e4\uac1c\ubcc0\uc218 \uc815\uc758<\/li>\n\n\n\n<li><code>responses<\/code>: HTTP \uc0c1\ud0dc \ucf54\ub4dc\ubcc4 \uc751\ub2f5 \uc815\uc758<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">\ud2b9\ud788 <code>operationId<\/code>\ub294 \ucf54\ub4dc \uc0dd\uc131 \ub3c4\uad6c\uc5d0\uc11c \uba54\uc11c\ub4dc \uc774\ub984\uc73c\ub85c \uc0ac\uc6a9\ub420 \uc218 \uc788\uc73c\ubbc0\ub85c \uc911\ubcf5\ub418\uc9c0 \uc54a\ub3c4\ub85d \uad00\ub9ac\ud558\ub294 \uac83\uc774 \uc88b\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc608\ub97c \ub4e4\uc5b4 <code>createUser<\/code>, <code>getUser<\/code>, <code>updateUser<\/code>\ucc98\ub7fc \ub3d9\uc791\uc744 \uba85\ud655\ud558\uac8c \ud45c\ud604\ud558\uba74 \uc0dd\uc131\ub41c SDK\uc5d0\uc11c\ub3c4 API\uc758 \ubaa9\uc801\uc744 \uc27d\uac8c \ud30c\uc545\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\">Request\uc640 Response \uc2a4\ud0a4\ub9c8 \uc815\uc758<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">API \uba85\uc138\uc5d0\uc11c \uc911\uc694\ud55c \ubd80\ubd84\uc740 \uc694\uccad\uacfc \uc751\ub2f5\uc758 \ub370\uc774\ud130 \uad6c\uc870\ub97c \uc815\ud655\ud558\uac8c \uc815\uc758\ud558\ub294 \uac83\uc774\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ud074\ub77c\uc774\uc5b8\ud2b8\uac00 \uc5b4\ub5a4 \ub370\uc774\ud130\ub97c \ubcf4\ub0b4\uc57c \ud558\ub294\uc9c0, \uc11c\ubc84\uac00 \uc5b4\ub5a4 \ub370\uc774\ud130\ub97c \ubc18\ud658\ud558\ub294\uc9c0 \uba85\uc2dc\ud574\uc57c \ud55c\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">\uc694\uccad \uc2a4\ud0a4\ub9c8 \uc815\uc758<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\uc0ac\uc6a9\uc790 \uc0dd\uc131 API\ub97c \uc608\ub85c \ub4e4\uc5b4\ubcf4\uc790.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>components:\n  schemas:\n    CreateUserRequest:\n      type: object\n      required:\n        - nickname\n      properties:\n        nickname:\n          type: string\n          minLength: 2\n          maxLength: 12\n          description: \uc0ac\uc6a9\uc790 \ub2c9\ub124\uc784\n          example: Player01<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774 \uba85\uc138\ub294 \ub2e4\uc74c\uacfc \uac19\uc740 \uaddc\uce59\uc744 \uc815\uc758\ud55c\ub2e4.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>\uc694\uccad \ub370\uc774\ud130\ub294 \uac1d\uccb4 \ud615\ud0dc\ub2e4.<\/li>\n\n\n\n<li><code>nickname<\/code>\uc740 \ud544\uc218 \ud56d\ubaa9\uc774\ub2e4.<\/li>\n\n\n\n<li>\ub2c9\ub124\uc784\uc740 \ubb38\uc790\uc5f4\uc774\uc5b4\uc57c \ud55c\ub2e4.<\/li>\n\n\n\n<li>\ub2c9\ub124\uc784\uc758 \uae38\uc774\ub294 2~12\uc790\ub2e4.<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">\ub2e4\uc74c\uc740 \uc720\ud6a8\ud55c \uc694\uccad\uc758 \uc608\uc2dc\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"nickname\": \"Player01\"\n}<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\ubc18\uba74 \ub2e4\uc74c \uc694\uccad\uc740 \uba85\uc138\uc0c1 \uc720\ud6a8\ud558\uc9c0 \uc54a\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"nickname\": \"\"\n}<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\"><code>minLength: 2<\/code> \uc870\uac74\uc744 \ub9cc\uc871\ud558\uc9c0 \uc54a\uae30 \ub54c\ubb38\uc774\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ub2e4\ub9cc <strong>OpenAPI\uc5d0 \uac80\uc99d \uaddc\uce59\uc744 \uc791\uc131\ud588\ub2e4\uace0 \ud574\uc11c \uc11c\ubc84\uc758 \uc785\ub825\uac12 \uac80\uc99d\uc774 \uc790\ub3d9\uc73c\ub85c \uc2e4\ud589\ub418\ub294 \uac83\uc740 \uc544\ub2c8\ub2e4.<\/strong> \uc11c\ubc84\ub294 \uc2e4\uc81c \uc694\uccad\uc744 \ucc98\ub9ac\ud560 \ub54c \ud574\ub2f9 \uaddc\uce59\uc744 \uac80\uc99d\ud574\uc57c \ud55c\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">\uc751\ub2f5 \uc2a4\ud0a4\ub9c8 \uc815\uc758<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\uc0ac\uc6a9\uc790 \uc0dd\uc131\uc5d0 \uc131\uacf5\ud588\uc744 \ub54c \ubc18\ud658\ud558\ub294 \ub370\uc774\ud130\ub3c4 \uc815\uc758\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>components:\n  schemas:\n    UserResponse:\n      type: object\n      required:\n        - id\n        - nickname\n      properties:\n        id:\n          type: string\n          description: \uc0ac\uc6a9\uc790 \uace0\uc720 \uc2dd\ubcc4\uc790\n          example: user_123\n        nickname:\n          type: string\n          example: Player01<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc751\ub2f5 \uc608\uc2dc\ub294 \ub2e4\uc74c\uacfc \uac19\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"id\": \"user_123\",\n  \"nickname\": \"Player01\"\n}<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc694\uccad \uc2a4\ud0a4\ub9c8\uc640 \uc751\ub2f5 \uc2a4\ud0a4\ub9c8\ub97c \ubd84\ub9ac\ud558\uba74 \ud074\ub77c\uc774\uc5b8\ud2b8\uac00 \uc804\ub2ec\ud574\uc57c \ud558\ub294 \ub370\uc774\ud130\uc640 \uc11c\ubc84\uac00 \ubc18\ud658\ud558\ub294 \ub370\uc774\ud130\ub97c \uba85\ud655\ud558\uac8c \uad6c\ubd84\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ub610\ud55c \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ubaa8\ub378\uc744 \uadf8\ub300\ub85c API \uc751\ub2f5\uc73c\ub85c \ub178\ucd9c\ud558\uc9c0 \uc54a\uace0, API \uc804\uc6a9 DTO(Data Transfer Object)\ub97c \uc815\uc758\ud558\ub294 \uc124\uacc4\uc640\ub3c4 \uc798 \ub9de\ub294\ub2e4.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\">components\/schemas\uc640 \uacf5\ud1b5 \uc751\ub2f5<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\"><code>components<\/code>\ub294 \uc5ec\ub7ec API\uc5d0\uc11c \ubc18\ubcf5\uc801\uc73c\ub85c \uc0ac\uc6a9\ud558\ub294 \uc815\uc758\ub97c \ud55c\uacf3\uc5d0 \ubaa8\uc73c\ub294 \uc601\uc5ed\uc774\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ub300\ud45c\uc801\uc73c\ub85c \ub2e4\uc74c \ud56d\ubaa9\uc744 \uad00\ub9ac\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>schemas<\/code>: \uc694\uccad \ubc0f \uc751\ub2f5 \ub370\uc774\ud130 \uad6c\uc870<\/li>\n\n\n\n<li><code>responses<\/code>: \uacf5\ud1b5 \uc751\ub2f5 \uc815\uc758<\/li>\n\n\n\n<li><code>parameters<\/code>: \uacf5\ud1b5 \ub9e4\uac1c\ubcc0\uc218 \uc815\uc758<\/li>\n\n\n\n<li><code>securitySchemes<\/code>: \uc778\uc99d \ubc29\uc2dd \uc815\uc758<\/li>\n\n\n\n<li><code>headers<\/code>: \uacf5\ud1b5 \ud5e4\ub354 \uc815\uc758<\/li>\n\n\n\n<li><code>examples<\/code>: \uc7ac\uc0ac\uc6a9 \uac00\ub2a5\ud55c \uc608\uc2dc<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">\uacf5\ud1b5 \uc624\ub958 \uc751\ub2f5 \uc815\uc758<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\uac8c\uc784 \uc11c\ubc84\uc5d0\uc11c\ub294 \ub2c9\ub124\uc784 \uc911\ubcf5, \uc785\ub825\uac12 \uc624\ub958, \uc778\uc99d \uc2e4\ud328, \ub9ac\uc18c\uc2a4 \ubd80\uc7ac \ub4f1 \ub2e4\uc591\ud55c \uc624\ub958\uac00 \ubc1c\uc0dd\ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774\ub54c \ubaa8\ub4e0 API\uac00 \uc11c\ub85c \ub2e4\ub978 \uc624\ub958 \uad6c\uc870\ub97c \ubc18\ud658\ud558\uba74 \ud074\ub77c\uc774\uc5b8\ud2b8\uc758 \uc624\ub958 \ucc98\ub9ac \ub85c\uc9c1\uc774 \ubcf5\uc7a1\ud574\uc9c4\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ub530\ub77c\uc11c \uacf5\ud1b5 \uc624\ub958 \uc751\ub2f5 \uad6c\uc870\ub97c \uc815\uc758\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>components:\n  schemas:\n    ErrorResponse:\n      type: object\n      required:\n        - code\n        - message\n      properties:\n        code:\n          type: string\n          description: \uc560\ud50c\ub9ac\ucf00\uc774\uc158 \uc624\ub958 \ucf54\ub4dc\n          example: NICKNAME_DUPLICATED\n        message:\n          type: string\n          description: \uc624\ub958 \uc124\uba85\n          example: \uc774\ubbf8 \uc0ac\uc6a9 \uc911\uc778 \ub2c9\ub124\uc784\uc785\ub2c8\ub2e4.<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc624\ub958 \uc751\ub2f5\uc740 \ub2e4\uc74c\uacfc \uac19\uc740 \ud615\ud0dc\uac00 \ub41c\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"code\": \"NICKNAME_DUPLICATED\",\n  \"message\": \"\uc774\ubbf8 \uc0ac\uc6a9 \uc911\uc778 \ub2c9\ub124\uc784\uc785\ub2c8\ub2e4.\"\n}<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">HTTP \uc0c1\ud0dc \ucf54\ub4dc\uc640 \uc560\ud50c\ub9ac\ucf00\uc774\uc158 \uc624\ub958 \ucf54\ub4dc\ub294 \uc5ed\ud560\uc774 \ub2e4\ub974\ub2e4.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>HTTP \uc0c1\ud0dc \ucf54\ub4dc <code>409<\/code>: \uc694\uccad\uc774 \ud604\uc7ac \ub9ac\uc18c\uc2a4 \uc0c1\ud0dc\uc640 \ucda9\ub3cc\ud568<\/li>\n\n\n\n<li>\uc560\ud50c\ub9ac\ucf00\uc774\uc158 \uc624\ub958 \ucf54\ub4dc <code>NICKNAME_DUPLICATED<\/code>: \ub2c9\ub124\uc784 \uc911\ubcf5\uc774\ub77c\ub294 \uad6c\uccb4\uc801\uc778 \uc5c5\ubb34 \uc624\ub958<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">HTTP \uc0c1\ud0dc \ucf54\ub4dc\ub294 \ud1b5\uc2e0 \uacb0\uacfc\ub97c \ud45c\ud604\ud558\uace0, \uc560\ud50c\ub9ac\ucf00\uc774\uc158 \uc624\ub958 \ucf54\ub4dc\ub294 \ud074\ub77c\uc774\uc5b8\ud2b8\uac00 \uad6c\uccb4\uc801\uc778 \uc2e4\ud328 \uc6d0\uc778\uc744 \uc2dd\ubcc4\ud558\ub3c4\ub85d \ub3d5\ub294\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">\uacf5\ud1b5 \uc751\ub2f5 \uc7ac\uc0ac\uc6a9<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\uac19\uc740 \uc624\ub958 \uc2a4\ud0a4\ub9c8\ub97c \uc5ec\ub7ec API\uc5d0\uc11c \ucc38\uc870\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>paths:\n  \/users:\n    post:\n      summary: \uc0ac\uc6a9\uc790 \uc0dd\uc131\n\n      responses:\n        \"201\":\n          description: \uc0ac\uc6a9\uc790 \uc0dd\uc131 \uc131\uacf5\n          content:\n            application\/json:\n              schema:\n                $ref: \"#\/components\/schemas\/UserResponse\"\n\n        \"400\":\n          description: \uc798\ubabb\ub41c \uc694\uccad\n          content:\n            application\/json:\n              schema:\n                $ref: \"#\/components\/schemas\/ErrorResponse\"\n\n        \"409\":\n          description: \ub2c9\ub124\uc784 \uc911\ubcf5\n          content:\n            application\/json:\n              schema:\n                $ref: \"#\/components\/schemas\/ErrorResponse\"<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\"><code>$ref<\/code>\ub294 \uc774\ubbf8 \uc815\uc758\ud55c \uc2a4\ud0a4\ub9c8\ub97c \ucc38\uc870\ud558\ub294 \uae30\ub2a5\uc774\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774\ub97c \uc0ac\uc6a9\ud558\uba74 \ub3d9\uc77c\ud55c \ub370\uc774\ud130 \uad6c\uc870\ub97c \ubc18\ubcf5\ud574\uc11c \uc791\uc131\ud560 \ud544\uc694\uac00 \uc5c6\ub2e4. \uacf5\ud1b5 \uc624\ub958 \ud615\uc2dd\uc774 \ubcc0\uacbd\ub418\ub354\ub77c\ub3c4 \ucc38\uc870\ud558\ub294 API\ub4e4\uc774 \ub3d9\uc77c\ud55c \uad6c\uc870\ub97c \uc0ac\uc6a9\ud558\ub3c4\ub85d \uad00\ub9ac\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uacf5\ud1b5 \uc751\ub2f5\uc744 \ub354 \uc801\uadf9\uc801\uc73c\ub85c \uc7ac\uc0ac\uc6a9\ud558\ub824\uba74 <code>components\/responses<\/code>\uc5d0 \uc0c1\ud0dc \ucf54\ub4dc\ubcc4 \uc751\ub2f5 \uc815\uc758\ub97c \ub4f1\ub85d\ud560 \uc218\ub3c4 \uc788\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>components:\n  responses:\n    BadRequest:\n      description: \uc798\ubabb\ub41c \uc694\uccad\n      content:\n        application\/json:\n          schema:\n            $ref: \"#\/components\/schemas\/ErrorResponse\"\n\n    Unauthorized:\n      description: \uc778\uc99d \uc2e4\ud328\n      content:\n        application\/json:\n          schema:\n            $ref: \"#\/components\/schemas\/ErrorResponse\"<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">API\uc5d0\uc11c\ub294 \ub2e4\uc74c\uacfc \uac19\uc774 \ucc38\uc870\ud55c\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>responses:\n  \"400\":\n    $ref: \"#\/components\/responses\/BadRequest\"\n\n  \"401\":\n    $ref: \"#\/components\/responses\/Unauthorized\"<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774\ub807\uac8c \uad6c\uc131\ud558\uba74 API\ub9c8\ub2e4 \ubc18\ubcf5\ub418\ub294 \uc751\ub2f5 \uc815\uc758\ub97c \uc904\uc774\uace0 \uba85\uc138\uc758 \uc77c\uad00\uc131\uc744 \uc720\uc9c0\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\">\uc778\uc99d \ubc29\uc2dd \uba85\uc138<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">\uc778\uc99d\uc774 \ud544\uc694\ud55c API\ub294 OpenAPI\uc758 <code>securitySchemes<\/code>\ub97c \uc0ac\uc6a9\ud574 \uc778\uc99d \ubc29\uc2dd\uc744 \uc815\uc758\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">JWT \uae30\ubc18 Bearer \uc778\uc99d\uc744 \uc608\ub85c \ub4e4\uc5b4\ubcf4\uc790.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>components:\n  securitySchemes:\n    BearerAuth:\n      type: http\n      scheme: bearer\n      bearerFormat: JWT<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774 \uc124\uc815\uc740 HTTP Bearer \uc778\uc99d\uc744 \uc0ac\uc6a9\ud558\uba70 \ud1a0\ud070 \ud615\uc2dd\uc73c\ub85c JWT\ub97c \uc0ac\uc6a9\ud55c\ub2e4\ub294 \uc758\ubbf8\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc778\uc99d\uc774 \ud544\uc694\ud55c API\uc5d0 \ub2e4\uc74c\uacfc \uac19\uc774 \uc801\uc6a9\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>paths:\n  \/users\/me:\n    get:\n      summary: \ub0b4 \uc815\ubcf4 \uc870\ud68c\n\n      security:\n        - BearerAuth: &#91;]\n\n      responses:\n        \"200\":\n          description: \uc870\ud68c \uc131\uacf5\n\n        \"401\":\n          description: \uc778\uc99d \uc2e4\ud328<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\ud074\ub77c\uc774\uc5b8\ud2b8\ub294 \ub2e4\uc74c\uacfc \uac19\uc740 HTTP \ud5e4\ub354\ub97c \uc0ac\uc6a9\ud574 \uc694\uccad\ud55c\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>GET \/users\/me HTTP\/1.1\nHost: api.example.com\nAuthorization: Bearer eyJhbGciOi...<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">Swagger UI\uc5d0\uc11c\ub3c4 \ud1a0\ud070\uc744 \uc785\ub825\ud574 \uc778\uc99d\uc774 \ud544\uc694\ud55c API\ub97c \ud14c\uc2a4\ud2b8\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">\uc804\uc5ed \uc778\uc99d\uacfc \uac1c\ubcc4 \uc778\uc99d<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\ubaa8\ub4e0 API\uc5d0 \uae30\ubcf8\uc801\uc73c\ub85c \uc778\uc99d\uc744 \uc694\uad6c\ud558\ub824\uba74 \ucd5c\uc0c1\uc704 \uc601\uc5ed\uc5d0 <code>security<\/code>\ub97c \uc124\uc815\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>security:\n  - BearerAuth: &#91;]<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774 \uacbd\uc6b0 \uac1c\ubcc4 API\uc5d0 \ubcc4\ub3c4\uc758 \uc124\uc815\uc774 \uc5c6\ub2e4\uba74 \uc804\uc5ed \uc778\uc99d \uc815\ucc45\uc744 \ub530\ub978\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ubc18\ub300\ub85c \ub85c\uadf8\uc778\uc774\ub098 \ud68c\uc6d0\uac00\uc785\ucc98\ub7fc \uc778\uc99d \uc5c6\uc774 \uc811\uadfc\ud560 \uc218 \uc788\ub294 API\ub294 \ub2e4\uc74c\uacfc \uac19\uc774 \uc124\uc815\ud55c\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>paths:\n  \/auth\/login:\n    post:\n      summary: \ub85c\uadf8\uc778\n      security: &#91;]<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774 \uc124\uc815\uc740 \ud574\ub2f9 API\uc5d0 \uc801\uc6a9\ub418\ub294 \uc0c1\uc704 \uc778\uc99d \uc694\uad6c \uc0ac\ud56d\uc744 \ube44\uc6b4\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc911\uc694\ud55c \uc810\uc740 OpenAPI\uc758 \uc778\uc99d \uba85\uc138\uac00 \uc2e4\uc81c \uc11c\ubc84\uc758 \uc778\uc99d \ubc0f \uad8c\ud55c \uac80\uc0ac\ub97c \ub300\uc2e0\ud558\uc9c0 \uc54a\ub294\ub2e4\ub294 \uac83\uc774\ub2e4. \uc11c\ubc84\ub294 \ud1a0\ud070\uc758 \uc720\ud6a8\uc131, \ub9cc\ub8cc \uc5ec\ubd80, \uc0ac\uc6a9\uc790 \uad8c\ud55c \ub4f1\uc744 \uc2e4\uc81c \uc694\uccad\uc5d0\uc11c \uac80\uc99d\ud574\uc57c \ud55c\ub2e4.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\">Swagger UI\uc640 Swagger Editor<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">OpenAPI \uba85\uc138\ub97c \uc791\uc131\ud55c \ub4a4\uc5d0\ub294 Swagger \ub3c4\uad6c\ub97c \ud65c\uc6a9\ud574 \ubb38\uc11c\ub97c \ud655\uc778\ud558\uace0 \ud14c\uc2a4\ud2b8\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Swagger UI<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Swagger UI\ub294 OpenAPI \uba85\uc138\ub97c \uc6f9 \ubb38\uc11c\ub85c \ubcc0\ud658\ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uac1c\ubc1c\uc790\ub294 API \ubaa9\ub85d\uc744 \ud655\uc778\ud558\uace0 \uac01 API\uc758 \uc694\uccad \ud30c\ub77c\ubbf8\ud130, \uc694\uccad \ubcf8\ubb38, \uc751\ub2f5 \uc0c1\ud0dc \ucf54\ub4dc \ub4f1\uc744 \uc0b4\ud3b4\ubcfc \uc218 \uc788\ub2e4. \ub610\ud55c <code>Try it out<\/code> \uae30\ub2a5\uc744 \ud1b5\ud574 \uc2e4\uc81c API \uc694\uccad\uc744 \uc2e4\ud589\ud560 \uc218\ub3c4 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ub300\ud45c\uc801\uc778 \ud65c\uc6a9 \ubc29\ubc95\uc740 \ub2e4\uc74c\uacfc \uac19\ub2e4.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>API \uacbd\ub85c\uc640 HTTP \uba54\uc11c\ub4dc \ud655\uc778<\/li>\n\n\n\n<li>\uc694\uccad \ubc0f \uc751\ub2f5 \uc2a4\ud0a4\ub9c8 \ud655\uc778<\/li>\n\n\n\n<li>\uc778\uc99d \ud1a0\ud070 \uc785\ub825<\/li>\n\n\n\n<li>API \uc694\uccad \uc2e4\ud589<\/li>\n\n\n\n<li>\uc11c\ubc84\uc758 \uc2e4\uc81c \uc751\ub2f5 \ud655\uc778<\/li>\n\n\n\n<li>\uc624\ub958 \uc751\ub2f5\uacfc \uc0c1\ud0dc \ucf54\ub4dc \uac80\uc99d<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">\uc608\ub97c \ub4e4\uc5b4 \ud504\ub860\ud2b8\uc5d4\ub4dc \uac1c\ubc1c\uc790\uac00 \ubc31\uc5d4\ub4dc \uad6c\ud604 \ucf54\ub4dc\ub97c \uc9c1\uc811 \ud655\uc778\ud558\uc9c0 \uc54a\uc544\ub3c4 Swagger UI\uc5d0\uc11c API \uacc4\uc57d\uc744 \ud30c\uc545\ud558\uace0 \ud14c\uc2a4\ud2b8\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ub2e4\ub9cc \uc2e4\uc81c \uc694\uccad \uc2e4\ud589\uc740 \uc11c\ubc84\uc758 CORS \uc124\uc815, \uc778\uc99d \uc815\ucc45, \ub124\ud2b8\uc6cc\ud06c \uc811\uadfc\uc131 \ub4f1\uc5d0 \uc601\ud5a5\uc744 \ubc1b\ub294\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Swagger Editor<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Swagger Editor\ub294 OpenAPI \uba85\uc138\ub97c \uc791\uc131\ud558\uace0 \uac80\uc99d\ud558\ub294 \ub3c4\uad6c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">YAML\uc774\ub098 JSON\uc73c\ub85c \uc791\uc131\ud55c \uba85\uc138\uc758 \ubb38\ubc95 \uc624\ub958, \uad6c\uc870\uc801 \ubb38\uc81c, \uc77c\ubd80 \uaddc\uaca9 \uc704\ubc18\uc744 \ud655\uc778\ud558\ub294 \ub370 \ud65c\uc6a9\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc608\ub97c \ub4e4\uc5b4 \ub2e4\uc74c\uacfc \uac19\uc774 \uc791\uc131\ud558\uba74 YAML \ubb38\ubc95\uc774\ub098 OpenAPI \uad6c\uc870\uc5d0 \ubb38\uc81c\uac00 \ubc1c\uc0dd\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>paths:\n  \/users:\n    post:\n      responses:\n        \"201\"\n          description: \uc131\uacf5<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\"><code>\"201\"<\/code> \ub2e4\uc74c\uc5d0 \ucf5c\ub860\uc774 \ube60\uc838 \uc788\uae30 \ub54c\ubb38\uc5d0 YAML \ubb38\ubc95 \uc624\ub958\uac00 \ubc1c\uc0dd\ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Swagger Editor\ub97c \uc0ac\uc6a9\ud558\uba74 \uc774\ub7ec\ud55c \ubb38\uc81c\ub97c \uc870\uae30\uc5d0 \ubc1c\uacac\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc815\ub9ac\ud558\uba74 Swagger Editor\ub294 \uba85\uc138 \uc791\uc131\uacfc \uac80\uc99d\uc5d0, Swagger UI\ub294 \uba85\uc138\ub97c \uc2dc\uac01\ud654\ud558\uace0 API\ub97c \ud14c\uc2a4\ud2b8\ud558\ub294 \ub370 \uc911\uc810\uc744 \ub454\ub2e4.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\">OpenAPI\ub97c Node.js \uc11c\ubc84\uc5d0 \uc801\uc6a9\ud558\uae30<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">Node.js\uc640 Express \uae30\ubc18 \uc11c\ubc84\uc5d0\uc11c\ub294 OpenAPI \uba85\uc138\ub97c \uc791\uc131\ud558\uace0 Swagger UI\ub97c \uc5f0\uacb0\ud574 API \ubb38\uc11c\ub97c \uc81c\uacf5\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ub300\ud45c\uc801\uc778 \ub77c\uc774\ube0c\ub7ec\ub9ac\ub294 \ub2e4\uc74c\uacfc \uac19\ub2e4.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>swagger-ui-express<\/code>: Express \uc11c\ubc84\uc5d0\uc11c Swagger UI \uc81c\uacf5<\/li>\n\n\n\n<li><code>swagger-jsdoc<\/code>: \ucf54\ub4dc \uc8fc\uc11d\uc744 \uae30\ubc18\uc73c\ub85c OpenAPI \uba85\uc138 \uc0dd\uc131<\/li>\n\n\n\n<li><code>@asteasolutions\/zod-to-openapi<\/code>: Zod \uc2a4\ud0a4\ub9c8\ub97c OpenAPI \uba85\uc138\ub85c \ubcc0\ud658\ud558\ub294 \ub370 \ud65c\uc6a9\ud560 \uc218 \uc788\ub294 \ub77c\uc774\ube0c\ub7ec\ub9ac<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">\uc5ec\uae30\uc11c\ub294 \ubcc4\ub3c4\uc758 YAML \ud30c\uc77c\uc744 \uc791\uc131\ud558\uace0 Swagger UI\uc5d0 \uc5f0\uacb0\ud558\ub294 \ubc29\ubc95\uc744 \uc0b4\ud3b4\ubcf4\uc790.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">\ud328\ud0a4\uc9c0 \uc124\uce58<\/h3>\n\n\n\n<pre class=\"wp-block-code\"><code>npm install express swagger-ui-express yaml\nnpm install -D @types\/express @types\/swagger-ui-express @types\/node typescript<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">TypeScript \ud658\uacbd\uc5d0\uc11c \uc791\uc5c5\ud55c\ub2e4\uace0 \uac00\uc815\ud55c\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">OpenAPI \uba85\uc138 \uc791\uc131<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\"><code>openapi.yaml<\/code> \ud30c\uc77c\uc744 \uc0dd\uc131\ud55c\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>openapi: 3.0.3\n\ninfo:\n  title: Game Server API\n  version: 1.0.0\n\nservers:\n  - url: http:\/\/localhost:3000\n\npaths:\n  \/users\/{userId}:\n    get:\n      summary: \uc0ac\uc6a9\uc790 \uc870\ud68c\n      operationId: getUser\n\n      parameters:\n        - name: userId\n          in: path\n          required: true\n          schema:\n            type: string\n\n      responses:\n        \"200\":\n          description: \uc870\ud68c \uc131\uacf5\n          content:\n            application\/json:\n              schema:\n                $ref: \"#\/components\/schemas\/UserResponse\"\n\n        \"404\":\n          $ref: \"#\/components\/responses\/NotFound\"\n\ncomponents:\n  schemas:\n    UserResponse:\n      type: object\n      required:\n        - id\n        - nickname\n      properties:\n        id:\n          type: string\n        nickname:\n          type: string\n\n    ErrorResponse:\n      type: object\n      required:\n        - code\n        - message\n      properties:\n        code:\n          type: string\n        message:\n          type: string\n\n  responses:\n    NotFound:\n      description: \uc0ac\uc6a9\uc790\ub97c \ucc3e\uc744 \uc218 \uc5c6\uc74c\n      content:\n        application\/json:\n          schema:\n            $ref: \"#\/components\/schemas\/ErrorResponse\"<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Express \uc11c\ubc84\uc5d0 Swagger UI \uc5f0\uacb0<\/h3>\n\n\n\n<pre class=\"wp-block-code\"><code>import express from \"express\";\nimport swaggerUi from \"swagger-ui-express\";\nimport fs from \"node:fs\";\nimport YAML from \"yaml\";\n\nconst app = express();\n\napp.use(express.json());\n\nconst openapiDocument = YAML.parse(\n  fs.readFileSync(\".\/openapi.yaml\", \"utf8\")\n);\n\napp.use(\n  \"\/api-docs\",\n  swaggerUi.serve,\n  swaggerUi.setup(openapiDocument)\n);\n\napp.get(\"\/users\/:userId\", (req, res) =&gt; {\n  const { userId } = req.params;\n\n  if (userId !== \"user_123\") {\n    return res.status(404).json({\n      code: \"USER_NOT_FOUND\",\n      message: \"\uc0ac\uc6a9\uc790\ub97c \ucc3e\uc744 \uc218 \uc5c6\uc2b5\ub2c8\ub2e4.\",\n    });\n  }\n\n  return res.status(200).json({\n    id: \"user_123\",\n    nickname: \"Player01\",\n  });\n});\n\napp.listen(3000, () =&gt; {\n  console.log(\"Server running on port 3000\");\n});<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc11c\ubc84\ub97c \uc2e4\ud589\ud558\uba74 \ub2e4\uc74c \uc8fc\uc18c\uc5d0\uc11c API \ubb38\uc11c\ub97c \ud655\uc778\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\"><code>http:\/\/localhost:3000\/api-docs<\/code><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc704 \ucf54\ub4dc\ub294 Swagger UI \uc5f0\uacb0\uc744 \ubcf4\uc5ec\uc8fc\ub294 \ucd5c\uc18c \uc608\uc81c\ub2e4. \uc2e4\uc81c \ud504\ub85c\uc81d\ud2b8\uc5d0\uc11c\ub294 YAML \ud30c\uc77c\uc758 \uacbd\ub85c\ub97c \uc2e4\ud589 \ud658\uacbd\uc5d0 \ub9de\uac8c \uad00\ub9ac\ud558\uace0, \ub77c\uc6b0\ud2b8\uc640 \uba85\uc138\uc758 \uc77c\uce58 \uc5ec\ubd80\ub97c \uac80\uc99d\ud558\ub294 \uc808\ucc28\ub97c \ucd94\uac00\ud558\ub294 \uac83\uc774 \uc88b\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ud2b9\ud788 \uc774 \uc608\uc81c\uc5d0\uc11c\ub294 API \uba85\uc138\uc640 \uc2e4\uc81c Express \ub77c\uc6b0\ud2b8\uac00 \ubcc4\ub3c4\ub85c \uc791\uc131\ub418\uc5b4 \uc788\ub2e4. \ub530\ub77c\uc11c \uba85\uc138\uc5d0 \uc874\uc7ac\ud558\ub294 API\uac00 \uc2e4\uc81c\ub85c \uad6c\ud604\ub418\uc9c0 \uc54a\uc558\uac70\ub098, \uc2e4\uc81c \uc751\ub2f5\uc774 \uba85\uc138\uc640 \ub2ec\ub77c\uc9c0\ub294 \ubb38\uc81c\uac00 \ubc1c\uc0dd\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Swagger UI\uac00 \uc815\uc0c1\uc801\uc73c\ub85c \ud45c\uc2dc\ub41c\ub2e4\ub294 \uc0ac\uc2e4\ub9cc\uc73c\ub85c \uc11c\ubc84 \uad6c\ud604\uc774 \uba85\uc138\ub97c \uc900\uc218\ud55c\ub2e4\uace0 \ubcf4\uc7a5\ud560 \uc218\ub294 \uc5c6\ub2e4.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\">OpenAPI Generator<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">OpenAPI Generator\ub294 OpenAPI \uba85\uc138\ub97c \uae30\ubc18\uc73c\ub85c \ud074\ub77c\uc774\uc5b8\ud2b8 SDK, \uc11c\ubc84 \uc778\ud130\ud398\uc774\uc2a4, \ubaa8\ub378 \ud074\ub798\uc2a4 \ub4f1\uc758 \ucf54\ub4dc\ub97c \uc0dd\uc131\ud558\ub294 \ub3c4\uad6c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc608\ub97c \ub4e4\uc5b4 \ubc31\uc5d4\ub4dc\uc5d0\uc11c \ub2e4\uc74c\uacfc \uac19\uc740 API\ub97c \uc815\uc758\ud588\ub2e4\uace0 \uac00\uc815\ud558\uc790.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>paths:\n  \/users\/{userId}:\n    get:\n      operationId: getUser\n      parameters:\n        - name: userId\n          in: path\n          required: true\n          schema:\n            type: string\n      responses:\n        \"200\":\n          description: \uc870\ud68c \uc131\uacf5<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">OpenAPI Generator\ub97c \uc0ac\uc6a9\ud558\uba74 TypeScript, Java, C# \ub4f1 \uc9c0\uc6d0\ub418\ub294 \uc5b8\uc5b4\uc640 \uc0dd\uc131\uae30 \uc124\uc815\uc5d0 \ub530\ub77c API \ud638\ucd9c \ucf54\ub4dc\ub098 \ub370\uc774\ud130 \ubaa8\ub378\uc744 \uc0dd\uc131\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Unity \ud074\ub77c\uc774\uc5b8\ud2b8\uc640 Node.js \ubc31\uc5d4\ub4dc\uac00 \ud568\uaed8 \uc874\uc7ac\ud558\ub294 \uac8c\uc784 \ud504\ub85c\uc81d\ud2b8\ub77c\uba74 \ub2e4\uc74c\uacfc \uac19\uc740 \uad6c\uc131\uc744 \uace0\ub824\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>\ubc31\uc5d4\ub4dc: OpenAPI \uba85\uc138 \uc791\uc131 \ubc0f \uad00\ub9ac<\/li>\n\n\n\n<li>\uc6f9 \ud074\ub77c\uc774\uc5b8\ud2b8: TypeScript API \ud074\ub77c\uc774\uc5b8\ud2b8 \uc0dd\uc131<\/li>\n\n\n\n<li>Unity \ud074\ub77c\uc774\uc5b8\ud2b8: C# API \ud074\ub77c\uc774\uc5b8\ud2b8 \uc0dd\uc131<\/li>\n\n\n\n<li>\uacf5\ud1b5 \uae30\uc900: \ub3d9\uc77c\ud55c OpenAPI \uba85\uc138<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774 \uad6c\uc870\uc5d0\uc11c\ub294 \ud074\ub77c\uc774\uc5b8\ud2b8\uac00 \uc11c\ubc84\uc758 API \ud615\uc2dd\uc744 \uc218\uc791\uc5c5\uc73c\ub85c \uc911\ubcf5 \uc815\uc758\ud558\ub294 \ubd80\ub2f4\uc744 \uc904\uc77c \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">CLI \uc124\uce58 \ubc0f \ucf54\ub4dc \uc0dd\uc131<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">OpenAPI Generator CLI\ub294 Java \uc2e4\ud589 \ud658\uacbd\uc774 \ud544\uc694\ud558\ub2e4. \uc124\uce58 \ubc29\ubc95\uc740 \uc6b4\uc601\uccb4\uc81c\uc640 \ud504\ub85c\uc81d\ud2b8 \ud658\uacbd\uc5d0 \ub530\ub77c \ub2ec\ub77c\uc9c8 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">npm \ud328\ud0a4\uc9c0\ub97c \uc0ac\uc6a9\ud558\ub294 \uacbd\uc6b0 \ub2e4\uc74c\uacfc \uac19\uc774 \uc124\uce58\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>npm install @openapitools\/openapi-generator-cli --save-dev<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">TypeScript \ud074\ub77c\uc774\uc5b8\ud2b8 \uc0dd\uc131 \uc608\uc2dc\ub294 \ub2e4\uc74c\uacfc \uac19\ub2e4.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>npx openapi-generator-cli generate \\\n  -i openapi.yaml \\\n  -g typescript-fetch \\\n  -o generated\/api-client<\/code><\/pre>\n\n\n\n<p class=\"wp-block-paragraph\">\uc8fc\uc694 \uc635\uc158\uc740 \ub2e4\uc74c\uacfc \uac19\ub2e4.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>-i<\/code>: \uc785\ub825 OpenAPI \uba85\uc138 \ud30c\uc77c<\/li>\n\n\n\n<li><code>-g<\/code>: \uc0dd\uc131\ud560 \uc5b8\uc5b4 \ub610\ub294 \ud504\ub808\uc784\uc6cc\ud06c\uc758 \uc0dd\uc131\uae30<\/li>\n\n\n\n<li><code>-o<\/code>: \uc0dd\uc131\ub41c \ucf54\ub4dc\uc758 \ucd9c\ub825 \uacbd\ub85c<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\"><code>typescript-fetch<\/code>\ub294 Fetch API \uae30\ubc18\uc758 TypeScript \ud074\ub77c\uc774\uc5b8\ud2b8 \uc0dd\uc131\uae30\ub2e4. \uc0dd\uc131\uae30\ub97c \uc120\ud0dd\ud560 \ub54c\ub294 \ub300\uc0c1 \uc5b8\uc5b4, \ub7f0\ud0c0\uc784, \uc0ac\uc6a9 \uc911\uc778 \ud504\ub808\uc784\uc6cc\ud06c\uc640 \ud638\ud658\ub418\ub294\uc9c0 \ud655\uc778\ud574\uc57c \ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc0dd\uc131\ub41c \ucf54\ub4dc\ub294 \ud504\ub85c\uc81d\ud2b8\uc5d0\uc11c \uc9c1\uc811 \uc791\uc131\ud55c \ucf54\ub4dc\uc640 \ubd84\ub9ac\ud574 \uad00\ub9ac\ud558\ub294 \uac83\uc774 \uc88b\ub2e4. \uba85\uc138\ub97c \ubcc0\uacbd\ud574 \ucf54\ub4dc\ub97c \ub2e4\uc2dc \uc0dd\uc131\ud560 \ub54c \uc218\uc791\uc5c5 \uc218\uc815 \ub0b4\uc6a9\uc774 \uc0ac\ub77c\uc9c0\ub294 \ubb38\uc81c\ub97c \ubc29\uc9c0\ud560 \uc218 \uc788\uae30 \ub54c\ubb38\uc774\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">\ucf54\ub4dc \uc0dd\uc131\uc758 \uc7a5\uc810\uacfc \uc8fc\uc758\uc810<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>\uc7a5\uc810<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>\ud074\ub77c\uc774\uc5b8\ud2b8\uc758 API \ud638\ucd9c \ucf54\ub4dc \uc791\uc131 \ubd80\ub2f4 \uac10\uc18c<\/li>\n\n\n\n<li>\uc694\uccad \ubc0f \uc751\ub2f5 \ubaa8\ub378\uc758 \uc77c\uad00\uc131 \ud5a5\uc0c1<\/li>\n\n\n\n<li>API \ubcc0\uacbd \uc0ac\ud56d\uc744 \ucf54\ub4dc\uc5d0 \ubc18\uc601\ud558\uae30 \uc26c\uc6c0<\/li>\n\n\n\n<li>\uc11c\ub85c \ub2e4\ub978 \uc5b8\uc5b4\ub97c \uc0ac\uc6a9\ud558\ub294 \ud074\ub77c\uc774\uc5b8\ud2b8 \uac04 \uacc4\uc57d \uacf5\uc720<\/li>\n\n\n\n<li>\ubc18\ubcf5\uc801\uc778 \ub370\uc774\ud130 \ubaa8\ub378 \uc791\uc131 \uac10\uc18c<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\"><strong>\uc8fc\uc758\uc810<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>\uba85\uc138\uac00 \ubd80\uc815\ud655\ud558\uba74 \uc798\ubabb\ub41c \ucf54\ub4dc\uac00 \uc0dd\uc131\ub420 \uc218 \uc788\uc74c<\/li>\n\n\n\n<li>\uc0dd\uc131\ub41c \ucf54\ub4dc\uc758 \uad6c\uc870\uc640 \uc758\uc874\uc131\uc774 \ud504\ub85c\uc81d\ud2b8\uc5d0 \uc801\ud569\ud55c\uc9c0 \ud655\uc778\ud574\uc57c \ud568<\/li>\n\n\n\n<li>\uc11c\ubc84\uc758 \uc2e4\uc81c \ub3d9\uc791\uacfc \uba85\uc138\uac00 \uc77c\uce58\ud558\ub294\uc9c0 \ubcc4\ub3c4\ub85c \uac80\uc99d\ud574\uc57c \ud568<\/li>\n\n\n\n<li>\uc0dd\uc131 \ucf54\ub4dc\uc758 \uc9c1\uc811 \uc218\uc815\uc740 \uc7ac\uc0dd\uc131 \uc2dc \uc720\uc2e4\ub420 \uc218 \uc788\uc74c<\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">\ucf54\ub4dc \uc0dd\uc131\uc740 \uc815\ud655\ud55c API \uacc4\uc57d\uc744 \ub300\uc2e0\ud558\uc9c0 \uc54a\ub294\ub2e4. \uc815\ud655\ud55c \uba85\uc138\uac00 \uba3c\uc800 \uc874\uc7ac\ud574\uc57c \ucf54\ub4dc \uc0dd\uc131\uc758 \ud6a8\uacfc\ub3c4 \uc5bb\uc744 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\">OpenAPI \uae30\ubc18 API \uac1c\ubc1c \uc6cc\ud06c\ud50c\ub85c<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">OpenAPI\ub97c \ud504\ub85c\uc81d\ud2b8\uc5d0 \ub3c4\uc785\ud560 \ub54c\ub294 \ub2e4\uc74c\uacfc \uac19\uc740 \uc791\uc5c5 \ud750\ub984\uc744 \uad6c\uc131\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<ol start=\"1\" class=\"wp-block-list\">\n<li><strong>API \uacc4\uc57d \uc815\uc758<\/strong>API \uacbd\ub85c, HTTP \uba54\uc11c\ub4dc, \uc694\uccad \ubc0f \uc751\ub2f5 \uc2a4\ud0a4\ub9c8, \uc0c1\ud0dc \ucf54\ub4dc, \uc778\uc99d \ubc29\uc2dd\uc744 \uc815\uc758\ud55c\ub2e4.<\/li>\n\n\n\n<li><strong>\uba85\uc138 \uac80\uc99d<\/strong>Swagger Editor\ub098 \ubcc4\ub3c4\uc758 \uac80\uc99d \ub3c4\uad6c\ub85c \ubb38\ubc95\uacfc \uba85\uc138 \uad6c\uc870\ub97c \uac80\uc0ac\ud55c\ub2e4.<\/li>\n\n\n\n<li><strong>API \uad6c\ud604<\/strong>Express \ub77c\uc6b0\ud2b8, \uc11c\ube44\uc2a4 \ub85c\uc9c1, DTO \ubc0f \uc785\ub825\uac12 \uac80\uc99d \ucf54\ub4dc\ub97c \uad6c\ud604\ud55c\ub2e4.<\/li>\n\n\n\n<li><strong>\ubb38\uc11c \uc81c\uacf5<\/strong>Swagger UI\ub97c \ud1b5\ud574 API \ubb38\uc11c\ub97c \uc81c\uacf5\ud55c\ub2e4.<\/li>\n\n\n\n<li><strong>\ud074\ub77c\uc774\uc5b8\ud2b8 \ucf54\ub4dc \uc0dd\uc131<\/strong>OpenAPI Generator\ub85c \ud544\uc694\ud55c SDK\ub098 \ubaa8\ub378 \ucf54\ub4dc\ub97c \uc0dd\uc131\ud55c\ub2e4.<\/li>\n\n\n\n<li><strong>\uacc4\uc57d \ud14c\uc2a4\ud2b8<\/strong>\uc2e4\uc81c \uc11c\ubc84 \uc751\ub2f5\uc774 OpenAPI \uba85\uc138\uc640 \uc77c\uce58\ud558\ub294\uc9c0 \uac80\uc99d\ud55c\ub2e4.<\/li>\n\n\n\n<li><strong>\ubc84\uc804 \uad00\ub9ac \ubc0f \ubc30\ud3ec<\/strong>\uba85\uc138 \ubcc0\uacbd\uc744 \ucf54\ub4dc \ubcc0\uacbd\uacfc \ud568\uaed8 \uad00\ub9ac\ud558\uace0, \ud558\uc704 \ud638\ud658\uc131\uc744 \ud655\uc778\ud55c \ub4a4 \ubc30\ud3ec\ud55c\ub2e4.<\/li>\n<\/ol>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774\ub7ec\ud55c \uc6cc\ud06c\ud50c\ub85c\ub97c \uc801\uc6a9\ud558\uba74 API \ubb38\uc11c\uac00 \ub2e8\uc21c\ud55c \uc124\uba85 \uc790\ub8cc\uc5d0 \uba38\ubb34\ub974\uc9c0 \uc54a\uace0 \uac1c\ubc1c\uacfc \ud14c\uc2a4\ud2b8 \uacfc\uc815\uc5d0 \uc9c1\uc811 \ud65c\uc6a9\ub418\ub294 \uacc4\uc57d\uc73c\ub85c \ubc1c\uc804\ud55c\ub2e4.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\">\uc2e4\ubb34\uc5d0\uc11c \uace0\ub824\ud560 \uc124\uacc4 \uc6d0\uce59<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">\uba85\uc138\uc640 \uad6c\ud604\uc758 \uc77c\uce58<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\uac00\uc7a5 \uc911\uc694\ud55c \uc6d0\uce59\uc740 \uba85\uc138\uc640 \uc2e4\uc81c \uc11c\ubc84 \uad6c\ud604\uc774 \uc77c\uce58\ud574\uc57c \ud55c\ub2e4\ub294 \uac83\uc774\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uba85\uc138\uc5d0\ub294 <code>200<\/code> \uc751\ub2f5\ub9cc \uc815\uc758\ub418\uc5b4 \uc788\ub294\ub370 \uc2e4\uc81c \uc11c\ubc84\uc5d0\uc11c <code>404<\/code>, <code>409<\/code>, <code>500<\/code> \ub4f1\uc758 \uc751\ub2f5\uc774 \ubc1c\uc0dd\ud55c\ub2e4\uba74 \ud074\ub77c\uc774\uc5b8\ud2b8 \uac1c\ubc1c\uc790\ub294 \uc608\uc0c1\ud558\uc9c0 \ubabb\ud55c \uacb0\uacfc\ub97c \ucc98\ub9ac\ud574\uc57c \ud55c\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc2e4\uc81c\ub85c \ubc1c\uc0dd\ud560 \uc218 \uc788\ub294 \uc0c1\ud0dc \ucf54\ub4dc\uc640 \uc751\ub2f5 \ud615\uc2dd\uc744 \uba85\uc138\uc5d0 \ud3ec\ud568\ud558\uace0, \uc790\ub3d9\ud654\ub41c \ud14c\uc2a4\ud2b8\ub85c \uc77c\uce58 \uc5ec\ubd80\ub97c \uac80\uc99d\ud558\ub294 \uac83\uc774 \uc88b\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">DTO\uc640 \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ubaa8\ub378 \ubd84\ub9ac<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\ub370\uc774\ud130\ubca0\uc774\uc2a4 \ubaa8\ub378\uc744 \uadf8\ub300\ub85c API \uc751\ub2f5\uc73c\ub85c \uc0ac\uc6a9\ud558\uba74 \ub0b4\ubd80 \ub370\uc774\ud130 \uad6c\uc870\uac00 \uc678\ubd80\uc5d0 \ub178\ucd9c\ub418\uac70\ub098 \ub370\uc774\ud130\ubca0\uc774\uc2a4 \ubcc0\uacbd\uc774 API \uacc4\uc57d\uc5d0 \uc601\ud5a5\uc744 \uc904 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ub530\ub77c\uc11c API \uc804\uc6a9 \uc694\uccad \ubc0f \uc751\ub2f5 DTO\ub97c \uc815\uc758\ud558\uace0 \uc774\ub97c OpenAPI \uc2a4\ud0a4\ub9c8\ub85c \ud45c\ud604\ud558\ub294 \ubc29\uc2dd\uc774 \uc720\uc6a9\ud558\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">\uc624\ub958 \uc751\ub2f5\uc758 \uc77c\uad00\uc131<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\ubaa8\ub4e0 API\uac00 \uc77c\uad00\ub41c \uc624\ub958 \uad6c\uc870\ub97c \uc0ac\uc6a9\ud558\uba74 \ud074\ub77c\uc774\uc5b8\ud2b8\uc5d0\uc11c \uacf5\ud1b5 \uc624\ub958 \ucc98\ub9ac\uae30\ub97c \uad6c\ud604\ud558\uae30 \uc27d\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\uc608\ub97c \ub4e4\uc5b4 HTTP \uc0c1\ud0dc \ucf54\ub4dc\uc640 \ud568\uaed8 <code>code<\/code>, <code>message<\/code>\ub97c \ubc18\ud658\ud558\uba74 \ud074\ub77c\uc774\uc5b8\ud2b8\ub294 \uc0c1\ud0dc \ucf54\ub4dc\ub85c \uc624\ub958 \ubc94\uc8fc\ub97c \ud310\ub2e8\ud558\uace0 \uc560\ud50c\ub9ac\ucf00\uc774\uc158 \uc624\ub958 \ucf54\ub4dc\ub85c \uad6c\uccb4\uc801\uc778 \uc6d0\uc778\uc744 \ucc98\ub9ac\ud560 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">\ud558\uc704 \ud638\ud658\uc131 \uc720\uc9c0<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">\uc774\ubbf8 \ubc30\ud3ec\ub41c \ud074\ub77c\uc774\uc5b8\ud2b8\uac00 \uc874\uc7ac\ud558\ub294 \uc0c1\ud0dc\uc5d0\uc11c \uc694\uccad \ud544\uc218\uac12\uc744 \ucd94\uac00\ud558\uac70\ub098 \uc751\ub2f5 \ud544\ub4dc\ub97c \uc81c\uac70\ud558\uba74 \uae30\uc874 \ud074\ub77c\uc774\uc5b8\ud2b8\uac00 \uc815\uc0c1\uc801\uc73c\ub85c \ub3d9\uc791\ud558\uc9c0 \uc54a\uc744 \uc218 \uc788\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">API\ub97c \ubcc0\uacbd\ud560 \ub54c\ub294 \uae30\uc874 \ud544\ub4dc\uc758 \uc81c\uac70, \ud544\uc218\uac12 \ubcc0\uacbd, \uc751\ub2f5 \ud615\uc2dd \ubcc0\uacbd \ub4f1\uc774 \ud558\uc704 \ud638\ud658\uc131\uc5d0 \ubbf8\uce58\ub294 \uc601\ud5a5\uc744 \uac80\ud1a0\ud574\uc57c \ud55c\ub2e4.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">\uc778\uc99d\uacfc \uad8c\ud55c \uac80\uc99d \ubd84\ub9ac<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">OpenAPI\ub294 \uc778\uc99d \ubc29\uc2dd\uc744 \ubb38\uc11c\ud654\ud558\uc9c0\ub9cc, \uc0ac\uc6a9\uc790\ubcc4 \uc811\uadfc \uad8c\ud55c\uae4c\uc9c0 \uc790\ub3d9\uc73c\ub85c \ubcf4\uc7a5\ud558\uc9c0\ub294 \uc54a\ub294\ub2e4.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">\ud1a0\ud070 \uac80\uc99d\ubfd0 \uc544\ub2c8\ub77c \uc694\uccad\ud55c \uc0ac\uc6a9\uc790\uac00 \ud574\ub2f9 \ub9ac\uc18c\uc2a4\uc5d0 \uc811\uadfc\ud560 \uc218 \uc788\ub294\uc9c0 \uc11c\ubc84\uc5d0\uc11c \ubcc4\ub3c4\ub85c \uac80\uc0ac\ud574\uc57c \ud55c\ub2e4.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Swagger\uc640 OpenAPI\ub780? \ubc31\uc5d4\ub4dc \uc11c\ubc84\ub97c \uac1c\ubc1c\ud560 \ub54c API\ub97c \uad6c\ud604\ud558\ub294 \uac83\ub9cc\ud07c \uc911\uc694\ud55c \uc791\uc5c5\uc774 API\uc758 \uaddc\uaca9\uc744 \uc815\uc758\ud558\uace0 \uacf5\uc720\ud558\ub294 \uac83\uc774\ub2e4. \ud074\ub77c\uc774\uc5b8\ud2b8 \uac1c\ubc1c\uc790\ub294 \uc11c\ubc84\uc5d0 \uc5b4\ub5a4 URL\ub85c \uc694\uccad\ud574\uc57c \ud558\ub294\uc9c0, \uc5b4\ub5a4 \ub370\uc774\ud130\ub97c \uc804\ub2ec\ud574\uc57c \ud558\ub294\uc9c0, \uc5b4\ub5a4 \uc751\ub2f5\uc744 \ubc1b\uc744 \uc218 \uc788\ub294\uc9c0 \uc54c\uc544\uc57c \ud55c\ub2e4. \uc11c\ubc84 \uac1c\ubc1c\uc790 \uc5ed\uc2dc API\uc758 \uc785\ub825\uac12, \uc751\ub2f5 \ud615\uc2dd, \uc778\uc99d \ubc29\uc2dd, \uc624\ub958 \ucf54\ub4dc\ub97c \uc77c\uad00\ub418\uac8c \uad00\ub9ac\ud574\uc57c \ud55c\ub2e4. \uc774\ub7ec\ud55c API\uc758 \uaddc\uaca9\uc744 \uc815\uc758\ud558\ub294 \ud45c\uc900\uc774 OpenAPI\uc774\uba70, \uc774\ub97c [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-2652","post","type-post","status-publish","format-standard","hentry","category-dev-logs"],"_links":{"self":[{"href":"https:\/\/wayhope.kro.kr\/index.php?rest_route=\/wp\/v2\/posts\/2652","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wayhope.kro.kr\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/wayhope.kro.kr\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/wayhope.kro.kr\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/wayhope.kro.kr\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=2652"}],"version-history":[{"count":1,"href":"https:\/\/wayhope.kro.kr\/index.php?rest_route=\/wp\/v2\/posts\/2652\/revisions"}],"predecessor-version":[{"id":2653,"href":"https:\/\/wayhope.kro.kr\/index.php?rest_route=\/wp\/v2\/posts\/2652\/revisions\/2653"}],"wp:attachment":[{"href":"https:\/\/wayhope.kro.kr\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=2652"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/wayhope.kro.kr\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=2652"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/wayhope.kro.kr\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=2652"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}