Преглед изворни кода

set API base path in reference

Ryu Sato пре 6 година
родитељ
комит
c4fa323723
2 измењених фајлова са 9 додато и 2 уклоњено
  1. 8 1
      config/swagger-definition.js
  2. 1 1
      package.json

+ 8 - 1
config/swagger-definition.js

@@ -1,6 +1,7 @@
 const pkg = require('../package.json');
 
 const apiVersion = process.env.API_VERSION || 3;
+const basePath = (apiVersion === 1 ? '/_api' : `/_api/v${apiVersion}`);
 
 module.exports = {
   openapi: '3.0.1',
@@ -10,7 +11,13 @@ module.exports = {
   },
   servers: [
     {
-      url: 'https://demo.growi.org',
+      url: 'https://demo.growi.org{basePath}',
+      variables: {
+        basePath: {
+          default: basePath,
+          description: 'base path',
+        },
+      },
     },
   ],
   security: [

+ 1 - 1
package.json

@@ -20,7 +20,7 @@
     "url": "https://github.com/weseek/growi/issues"
   },
   "scripts": {
-    "build:api:jsdoc": "swagger-jsdoc -o tmp/swagger.json -d config/swagger-definition.js ",
+    "build:api:jsdoc": "swagger-jsdoc -o tmp/swagger.json -d config/swagger-definition.js",
     "build:apiv3:jsdoc": "cross-env API_VERSION=3 npm run build:api:jsdoc -- \"src/server/routes/apiv3/**/*.js\" \"src/server/models/**/*.js\"",
     "build:apiv1:jsdoc": "cross-env API_VERSION=1 npm run build:api:jsdoc -- \"src/server/*/*.js\" \"src/server/models/**/*.js\"",
     "build:dev:app:watch": "npm run build:dev:app -- --watch",