mot public api

MOT公共API

MOT公共API

這是提供對公共 MOT 資料存取的 API 的原始程式碼。

它被編寫為一組 AWS Lambda，旨在連接到 AWS API Gateway 端點。

有一些單元測試覆蓋範圍，重點在於常用端點的最重要的程式碼路徑。

該儲存庫使用 git-secrets 來防止提交機密。請確保您的電腦上安裝了 git-secrets：https://github.com/awslabs/git-secrets#installing-git-secrets

本地建置和運行 TAPI

先決條件

• Java 8/JDK8

• AWS Sam CLI - https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install-mac.html

• MTS 資料庫啟動並運行

• MOTH 在本地運行 - https://github.com/dvsa/mot-history

• 在根目錄中運行cp .env.example .env - 這將使用範例檔案建立一個 .env 檔案。

• 在.env中，更改以下變數：-

• MOTH_API_URL: "http://docker.for.mac.localhost:3010"在本機使用 MOTH api

• MOTH_API_URL和對應的MOTH_API_KEY直接使用 MOTH api。

建造

要建立應用程序，請確保您位於根目錄中，然後：

sam build

跑步

要在本地運行應用程序，請確保在根目錄中成功構建，然後：

sam local start-api --env-vars .env

這將在http:://127.0.0.1:3000啟動應用程式。

注意：如果您想將連接埠號碼更改為 3001，請使用-p <port_number> 。

sam local start-api --env-vars .env -p 3001

template.yaml檔案中列出了所有路徑和環境。環境變數的值列在.env檔中。

您可以新增/編輯環境變數和路徑，如下所示：

template.yaml:

 Environment :
        Variables :
          MOTH_API_URL :
          MOTH_API_KEY :

.env:

{
  "Parameters" : {
    "MOTH_API_URL" : " https://api.search.com " ,
    "MOTH_API_KEY" : " randomKey "
  }
}

您可以編輯/新增端點：

template.yaml:

 Events :
  VrmGet :
    Type : Api
    Properties :
      Path : /trade/vehicles/mot-tests
      Method : GET
  VrmPost :
    Type : Api
    Properties :
      Path : /trade/vehicles/annual-tests
      Method : GET

每次編輯程式碼或template.yaml / .env時，您都需要建置： sam build並執行應用程式： sam local start-api --env-vars .env以查看變更。