Add documentation of the API using tspec

acc-coin · Aug 20, 2024 · 3282106 · 3282106
1 parent 95ccfec
commit 3282106
Show file tree

Hide file tree

Showing 29 changed files with 4,518 additions and 27 deletions.
diff --git a/packages/relay/.gitignore b/packages/relay/.gitignore
@@ -141,3 +141,4 @@ typechain-types
 cache
 artifacts
 
+generate/*
diff --git a/packages/relay/package.json b/packages/relay/package.json
@@ -103,6 +103,7 @@
         "ts-node": "^10.5.0",
         "tslint": "^6.1.3",
         "tslint-config-prettier": "^1.18.0",
+        "tspec": "^0.1.116",
         "typechain": "^8.1.0",
         "typescript": "^4.5.5",
         "urijs": "^1.19.7",

diff --git a/packages/relay/src/DefaultServer.ts b/packages/relay/src/DefaultServer.ts
@@ -221,17 +221,17 @@ export class DefaultServer extends WebService {
             })
         );
 
-        this.defaultRouter.registerRoutes();
-        this.ledgerRouter.registerRoutes();
-        this.shopRouter.registerRoutes();
-        this.paymentRouter.registerRoutes();
-        this.etcRouter.registerRoutes();
-        this.purchaseRouter.registerRoutes();
-        this.tokenRouter.registerRoutes();
-        this.phoneLinkRouter.registerRoutes();
-        this.providerRouter.registerRoutes();
-        this.bridgeRouter.registerRoutes();
-        this.historyRouter.registerRoutes();
+        await this.defaultRouter.registerRoutes();
+        await this.ledgerRouter.registerRoutes();
+        await this.shopRouter.registerRoutes();
+        await this.paymentRouter.registerRoutes();
+        await this.etcRouter.registerRoutes();
+        await this.purchaseRouter.registerRoutes();
+        await this.tokenRouter.registerRoutes();
+        await this.phoneLinkRouter.registerRoutes();
+        await this.providerRouter.registerRoutes();
+        await this.bridgeRouter.registerRoutes();
+        await this.historyRouter.registerRoutes();
 
         for (const m of this.schedules) await m.start();
 

diff --git a/packages/relay/src/routers/BridgeRouter.ts b/packages/relay/src/routers/BridgeRouter.ts
@@ -81,7 +81,7 @@ export class BridgeRouter {
         };
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         this.app.post(
             "/v1/bridge/withdraw",
             [

diff --git a/packages/relay/src/routers/DefaultRouter.ts b/packages/relay/src/routers/DefaultRouter.ts
@@ -3,6 +3,8 @@ import { ContractManager } from "../contract/ContractManager";
 import { Metrics } from "../metrics/Metrics";
 import { WebService } from "../service/WebService";
 
+import { Tspec, TspecDocsMiddleware } from "tspec";
+
 import { BigNumber, Wallet } from "ethers";
 import express from "express";
 
@@ -23,11 +25,12 @@ export class DefaultRouter {
         return this.web_service.app;
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         // Get Health Status
         this.app.get("/", [], this.getHealthStatus.bind(this));
         this.app.post("/callback", [], this.callback.bind(this));
         this.app.get("/metrics", [], this.getMetrics.bind(this));
+        this.app.use("/docs", await TspecDocsMiddleware());
     }
 
     private async getHealthStatus(req: express.Request, res: express.Response) {

diff --git a/packages/relay/src/routers/ETCRouter.ts b/packages/relay/src/routers/ETCRouter.ts
@@ -61,7 +61,7 @@ export class ETCRouter {
         };
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         // 포인트의 종류를 선택하는 기능
         this.app.post(
             "/v1/mobile/register",

diff --git a/packages/relay/src/routers/HistoryRouter.ts b/packages/relay/src/routers/HistoryRouter.ts
@@ -86,7 +86,7 @@ export class HistoryRouter {
         };
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         this.app.get(
             "/v1/token/main/history/:account",
             [

diff --git a/packages/relay/src/routers/LedgerRouter.ts b/packages/relay/src/routers/LedgerRouter.ts
@@ -86,7 +86,7 @@ export class LedgerRouter {
         };
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         this.app.get(
             "/v1/ledger/nonce/:account",
             [param("account").exists().trim().isEthereumAddress()],

diff --git a/packages/relay/src/routers/PaymentRouter.ts b/packages/relay/src/routers/PaymentRouter.ts
@@ -68,7 +68,7 @@ export class PaymentRouter {
         return this.web_service.app;
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         this.app.get(
             "/v1/payment/user/balance",
             [query("account").exists().trim().isEthereumAddress()],

diff --git a/packages/relay/src/routers/PhoneLinkRouter.ts b/packages/relay/src/routers/PhoneLinkRouter.ts
@@ -80,7 +80,7 @@ export class PhoneLinkRouter {
         };
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         this.app.get(
             "/v1/link/nonce/:account",
             [param("account").exists().trim().isEthereumAddress()],

diff --git a/packages/relay/src/routers/ProviderRouter.ts b/packages/relay/src/routers/ProviderRouter.ts
@@ -84,7 +84,7 @@ export class ProviderRouter {
         };
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         this.app.post(
             "/v1/provider/register",
             [

diff --git a/packages/relay/src/routers/ShopRouter.ts b/packages/relay/src/routers/ShopRouter.ts
@@ -101,7 +101,7 @@ export class ShopRouter {
         };
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         this.app.get(
             "/v1/shop/nonce/:account",
             [param("account").exists().trim().isEthereumAddress()],

diff --git a/packages/relay/src/routers/StorePurchaseRouter.ts b/packages/relay/src/routers/StorePurchaseRouter.ts
@@ -62,7 +62,7 @@ export class StorePurchaseRouter {
         };
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         this.app.post(
             "/v1/purchase/save",
             [

diff --git a/packages/relay/src/routers/TokenRouter.ts b/packages/relay/src/routers/TokenRouter.ts
@@ -84,7 +84,7 @@ export class TokenRouter {
         };
     }
 
-    public registerRoutes() {
+    public async registerRoutes() {
         this.app.get(
             "/v1/token/main/balance/:account",
             [param("account").exists().trim().isEthereumAddress()],

diff --git a/packages/relay/tspec.config.json b/packages/relay/tspec.config.json
@@ -0,0 +1,13 @@
+{
+    "specPathGlobs": ["tspec/**/*.ts"],
+    "tsconfigPath": "./tsconfig.json",
+    "outputPath": "./generate/openapi.json",
+    "specVersion": 3,
+    "openapi": {
+        "title": "Decentralized Loyalty System API",
+        "version": "1.0.0",
+        "description": "API of Decentralized Loyalty System</br></br><strong>The amount of tokens and points</strong></br>The amount of tokens and points is a string. The decimal place is 18. One point is expressed as \"100000000000000000000\".</br></br><strong>Responses</strong></br>Response data consists of three parts: `code`, `data`, `error`.</br>The value of code is 0 if normal. In this case, the value of data exists.</br>If an error occurs during the processing, the value of code is not zero. At this time, you can check the contents of error to find the cause."
+    },
+    "debug": false,
+    "ignoreErrors": true
+}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -141,3 +141,4 @@ typechain-types
		cache
		artifacts

		generate/*