Yuki Takei 1 год назад
Родитель
Сommit
46db6b8981

+ 0 - 15
apps/app/bin/openapi/swagger-jsdoc-apiv1.sh

@@ -1,15 +0,0 @@
-# USAGE:
-#   cd apps/app && sh bin/openapi/swagger-jsdoc-apiv3.sh
-#   APP_PATH=/path/to/apps/app sh bin/openapi/swagger-jsdoc-apiv3.sh
-#   APP_PATH=/path/to/apps/app OUT=/path/to/output sh bin/openapi/swagger-jsdoc-apiv3.sh
-
-APP_PATH=${APP_PATH:-"."}
-
-OUT=${OUT:-"${APP_PATH}/tmp/swagger-apiv1.json"}
-
-swagger-jsdoc \
-  -o "${OUT}" \
-  -d "${APP_PATH}/bin/openapi/swagger-definition-apiv1.js" \
-  "${APP_PATH}/src/server/routes/*/*.{js,ts}" \
-  "${APP_PATH}/src/server/routes/attachment/**/*.{js,ts}" \
-  "${APP_PATH}/src/server/models/openapi/**/*.{js,ts}"

+ 0 - 14
apps/app/bin/openapi/swagger-jsdoc-apiv3.sh

@@ -1,14 +0,0 @@
-# USAGE:
-#   cd apps/app && sh bin/openapi/swagger-jsdoc-apiv3.sh
-#   APP_PATH=/path/to/apps/app sh bin/openapi/swagger-jsdoc-apiv3.sh
-#   APP_PATH=/path/to/apps/app OUT=/path/to/output sh bin/openapi/swagger-jsdoc-apiv3.sh
-
-APP_PATH=${APP_PATH:-"."}
-
-OUT=${OUT:-"${APP_PATH}/tmp/swagger-apiv3.json"}
-
-swagger-jsdoc \
-  -o "${OUT}" \
-  -d "${APP_PATH}/bin/openapi/swagger-definition-apiv3.js" \
-  "${APP_PATH}/src/server/routes/apiv3/**/*.{js,ts}" \
-  "${APP_PATH}/src/server/models/openapi/**/*.{js,ts}"

+ 0 - 0
apps/app/bin/openapi/swagger-definition-apiv1.js → apps/app/bin/swagger-jsdoc/definition-apiv1.js


+ 0 - 0
apps/app/bin/openapi/swagger-definition-apiv3.js → apps/app/bin/swagger-jsdoc/definition-apiv3.js


+ 15 - 0
apps/app/bin/swagger-jsdoc/generate-spec-apiv1.sh

@@ -0,0 +1,15 @@
+# USAGE:
+#   cd apps/app && sh bin/swagger-jsdoc/generate-spec-apiv1.sh
+#   APP_PATH=/path/to/apps/app sh bin/swagger-jsdoc/generate-spec-apiv1.sh
+#   APP_PATH=/path/to/apps/app OUT=/path/to/output sh bin/swagger-jsdoc/generate-spec-apiv1.sh
+
+APP_PATH=${APP_PATH:-"."}
+
+OUT=${OUT:-"${APP_PATH}/tmp/openapi-spec-apiv1.json"}
+
+swagger-jsdoc \
+  -o "${OUT}" \
+  -d "${APP_PATH}/bin/swagger-jsdoc/definition-apiv1.js" \
+  "${APP_PATH}/src/server/routes/*/*.{js,ts}" \
+  "${APP_PATH}/src/server/routes/attachment/**/*.{js,ts}" \
+  "${APP_PATH}/src/server/models/openapi/**/*.{js,ts}"

+ 14 - 0
apps/app/bin/swagger-jsdoc/generate-spec-apiv3.sh

@@ -0,0 +1,14 @@
+# USAGE:
+#   cd apps/app && sh bin/swagger-jsdoc/generate-spec-apiv3.sh
+#   APP_PATH=/path/to/apps/app sh bin/swagger-jsdoc/generate-spec-apiv3.sh
+#   APP_PATH=/path/to/apps/app OUT=/path/to/output sh bin/swagger-jsdoc/generate-spec-apiv3.sh
+
+APP_PATH=${APP_PATH:-"."}
+
+OUT=${OUT:-"${APP_PATH}/tmp/openapi-spec-apiv3.json"}
+
+swagger-jsdoc \
+  -o "${OUT}" \
+  -d "${APP_PATH}/bin/swagger-jsdoc/definition-apiv3.js" \
+  "${APP_PATH}/src/server/routes/apiv3/**/*.{js,ts}" \
+  "${APP_PATH}/src/server/models/openapi/**/*.{js,ts}"

+ 6 - 6
apps/app/package.json

@@ -30,11 +30,11 @@
     "lint:typecheck": "npx -y tspc",
     "lint:eslint": "yarn eslint --quiet \"**/*.{js,jsx,ts,tsx}\"",
     "lint:styles": "stylelint \"src/**/*.scss\"",
-    "lint:swagger2openapi:apiv3": "node node_modules/.bin/oas-validate tmp/swagger-apiv3.json",
-    "lint:swagger2openapi:apiv1": "node node_modules/.bin/oas-validate tmp/swagger-apiv1.json",
+    "lint:swagger2openapi:apiv3": "node node_modules/.bin/oas-validate tmp/openapi-spec-apiv3.json",
+    "lint:swagger2openapi:apiv1": "node node_modules/.bin/oas-validate tmp/openapi-spec-apiv1.json",
     "lint": "run-p lint:*",
-    "prelint:swagger2openapi:apiv3": "yarn openapi:v3",
-    "prelint:swagger2openapi:apiv1": "yarn openapi:v1",
+    "prelint:swagger2openapi:apiv3": "yarn swagger2openapi:apiv3",
+    "prelint:swagger2openapi:apiv1": "yarn swagger2openapi:apiv1",
     "test": "run-p test:*",
     "test:jest": "cross-env NODE_ENV=test TS_NODE_PROJECT=test/integration/tsconfig.json jest",
     "test:vitest": "vitest run --coverage",
@@ -44,8 +44,8 @@
     "//// misc": "",
     "console": "yarn repl",
     "repl": "yarn cross-env NODE_ENV=development yarn ts-node src/server/repl.ts",
-    "openapi:v3": "sh bin/openapi/swagger-jsdoc-apiv3.sh",
-    "openapi:v1": "sh bin/openapi/swagger-jsdoc-apiv1.sh",
+    "swagger2openapi:apiv3": "sh bin/swagger-jsdoc/generate-spec-apiv3.sh",
+    "swagger2openapi:apiv1": "sh bin/swagger-jsdoc/generate-spec-apiv1.sh",
     "ts-node": "node -r ts-node/register/transpile-only -r tsconfig-paths/register -r dotenv-flow/config",
     "version": "yarn version --no-git-tag-version --non-interactive --preid=RC"
   },