Merge pull request #83 from traPtitech/improveApiReference

API参照先を変更

.github/workflows/main.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version-file: .node-version
           cache: npm
@@ -22,13 +22,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version-file: .node-version
           cache: npm
-      - run: SKIP_GENAPI=1 npm ci
-      - run: npm run postinstall
-      - uses: actions/upload-artifact@v3
+      - run: npm ci
+      - uses: actions/upload-artifact@v4
         with:
           name: apis
           path: ./src/lib/apis/generated
@@ -38,12 +37,12 @@ jobs:
     needs: [packages, genApi]
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version-file: .node-version
           cache: npm
       - run: SKIP_GENAPI=1 npm ci
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: apis
           path: ./src/lib/apis/generated
@@ -56,12 +55,12 @@ jobs:
     needs: [packages, genApi]
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version-file: .node-version
           cache: npm
       - run: SKIP_GENAPI=1 npm ci
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: apis
           path: ./src/lib/apis/generated
@@ -72,12 +71,12 @@ jobs:
     needs: [packages, genApi]
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version-file: .node-version
           cache: npm
       - run: SKIP_GENAPI=1 npm ci
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: apis
           path: ./src/lib/apis/generated
@@ -88,12 +87,12 @@ jobs:
     needs: [packages, genApi]
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version-file: .node-version
           cache: npm
       - run: SKIP_GENAPI=1 npm ci
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: apis
           path: ./src/lib/apis/generated

package.json

@@ -9,11 +9,9 @@
     "fix:format": "prettier --write src",
     "lint": "eslint --ext .ts,.vue src",
     "type-check": "tsc",
-    "fetch-openapi": "node scripts/fetchOpenapi.js",
     "gen-api": "node scripts/generateApi.js",
-    "start-mock": "prism mock -p 4010 -d scripts/traPortfolio.v1.yaml",
-    "clean": "rimraf scripts/traPorfolio.v1.yaml src/lib/apis/generated",
-    "postinstall": "npm run fetch-openapi && npm run gen-api"
+    "start-mock": "prism mock -p 4010 -d https://github.com/traPtitech/traPortfolio/blob/main/docs/swagger/traPortfolio.v1.yaml",
+    "postinstall": "npm run gen-api"
   },
   "dependencies": {
     "@iconify/iconify": "^3.1.1",

scripts/generateApi.js

@@ -7,7 +7,7 @@ const { promisify } = require('util')
 const execPromise = promisify(exec)
 const addApis = require('./addApis')
 
-const SWAGGER_PATH = 'scripts/traPortfolio.v1.yaml'
+const SWAGGER_PATH = 'https://raw.githubusercontent.com/traPtitech/traPortfolio/main/docs/swagger/traPortfolio.v1.yaml'
 const GENERATED_DIR = 'src/lib/apis/generated'
 
 const npx = process.platform === 'win32' ? 'npx.cmd' : 'npx'