mot public api

API Publik MOT

API Publik MOT

Ini adalah kode sumber untuk API yang menyediakan akses ke data MOT publik.

Ini ditulis sebagai satu set AWS Lambdas, yang dimaksudkan untuk dihubungkan ke titik akhir AWS API Gateway.

Ada beberapa cakupan pengujian unit, yang berfokus pada jalur kode paling penting untuk titik akhir yang sering digunakan.

Repositori ini menggunakan git-secrets untuk mencegah rahasia dikomit. Harap pastikan Anda telah menginstal git-secrets di mesin Anda: https://github.com/awslabs/git-secrets#installing-git-secrets

Membangun dan menjalankan TAPI Secara Lokal

Prasyarat

• Jawa 8/JDK8

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

• Basis data MTS aktif dan berjalan

• MOTH berjalan secara lokal - https://github.com/dvsa/mot-history

• Jalankan cp .env.example .env di direktori root - ini akan membuat file .env menggunakan file contoh.

• Di .env , ubah variabel berikut:-

• MOTH_API_URL: "http://docker.for.mac.localhost:3010" untuk menggunakan api MOTH secara lokal

• MOTH_API_URL dan MOTH_API_KEY yang sesuai untuk menggunakan api MOTH secara langsung.

Membangun

Untuk membangun aplikasi pastikan Anda berada di direktori root dan kemudian:

sam build

Berlari

Untuk menjalankan aplikasi secara lokal, pastikan build berhasil saat berada di direktori root dan kemudian:

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

Ini akan memulai aplikasi di http:://127.0.0.1:3000 .

CATATAN: Jika Anda ingin mengubah nomor port menjadi misalnya 3001, gunakan -p <port_number> .

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

Semua jalur dan lingkungan tercantum dalam file template.yaml . Nilai variabel lingkungan tercantum dalam file .env .

Anda dapat menambahkan/mengedit variabel dan jalur lingkungan seperti yang ditunjukkan di bawah ini:

template.yaml:

 Environment :
        Variables :
          MOTH_API_URL :
          MOTH_API_KEY :

.env:

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

Anda dapat mengedit/menambahkan titik akhir:

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

Setiap kali Anda mengedit kode atau template.yaml / .env Anda perlu membangun: sam build dan menjalankan aplikasi: sam local start-api --env-vars .env untuk melihat perubahannya.