mot public api

Öffentliche MOT-API

Öffentliche MOT-API

Dies ist der Quellcode für eine API, die Zugriff auf öffentliche MOT-Daten ermöglicht.

Es ist als Satz von AWS Lambdas geschrieben und soll mit AWS API Gateway-Endpunkten verbunden werden.

Es gibt eine gewisse Unit-Test-Abdeckung, die sich auf die wichtigsten Codepfade für häufig verwendete Endpunkte konzentriert.

Dieses Repository verwendet Git-Secrets, um zu verhindern, dass Geheimnisse festgeschrieben werden. Bitte stellen Sie sicher, dass Git-Secrets auf Ihrem Computer installiert sind: https://github.com/awslabs/git-secrets#installing-git-secrets

TAPI lokal erstellen und ausführen

Voraussetzung

• Java 8/JDK8

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

• MTS-Datenbank in Betrieb

• MOTH läuft lokal – https://github.com/dvsa/mot-history

• Führen Sie cp .env.example .env im Stammverzeichnis aus – dadurch wird eine .env-Datei mit der Beispieldatei erstellt.

• Ändern Sie in der .env die folgenden Variablen:-

• MOTH_API_URL: "http://docker.for.mac.localhost:3010" um die MOTH-API lokal zu verwenden

• MOTH_API_URL und der entsprechende MOTH_API_KEY um die MOTH-API direkt zu verwenden.

Bauen

Um die Anwendung zu erstellen, stellen Sie sicher, dass Sie sich im Stammverzeichnis befinden und gehen Sie dann wie folgt vor:

sam build

Laufen

Um die Anwendung lokal auszuführen, stellen Sie sicher, dass im Stammverzeichnis ein erfolgreicher Build durchgeführt wurde, und gehen Sie dann wie folgt vor:

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

Dadurch wird die Anwendung unter http:://127.0.0.1:3000 gestartet.

HINWEIS: Wenn Sie die Portnummer beispielsweise auf 3001 ändern möchten, verwenden Sie -p <port_number> .

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

Alle Pfade und Umgebungen sind in der Datei template.yaml aufgeführt. Die Werte der Umgebungsvariablen sind in der .env Datei aufgeführt.

Sie können Umgebungsvariablen und Pfade wie unten gezeigt hinzufügen/bearbeiten:

template.yaml:

 Environment :
        Variables :
          MOTH_API_URL :
          MOTH_API_KEY :

.env:

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

Sie können Endpunkte bearbeiten/hinzufügen:

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

Jedes Mal, wenn Sie den Code oder template.yaml / .env bearbeiten, müssen Sie Folgendes erstellen: sam build und die Anwendung ausführen: sam local start-api --env-vars .env um die Änderungen anzuzeigen.