mot public api

Публичный API ТО

Публичный API ТО

Это исходный код API, который обеспечивает доступ к общедоступным данным MOT.

Он написан как набор AWS Lambdas, предназначенный для подключения к конечным точкам AWS API Gateway.

Существует некоторое покрытие модульными тестами, сосредоточенное на наиболее важных путях кода для часто используемых конечных точек.

Этот репозиторий использует git-secrets для предотвращения передачи секретов. Убедитесь, что на вашем компьютере установлены git-secrets: https://github.com/awslabs/git-secrets#installing-git-secrets.

Создание и запуск TAPI локально

Предварительное условие

• Ява 8/JDK8

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

• База данных МТС запущена и работает.

• MOTH работает локально — https://github.com/dvsa/mot-history

• Запустите cp .env.example .env в корневом каталоге — это создаст файл .env с использованием файла примера.

• В .env измените следующие переменные:

• MOTH_API_URL: "http://docker.for.mac.localhost:3010" для локального использования API MOTH.

• MOTH_API_URL и соответствующий MOTH_API_KEY для прямого использования API MOTH.

Строить

Чтобы создать приложение, убедитесь, что вы находитесь в корневом каталоге, а затем:

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 чтобы увидеть изменения.