mot public api

API pública MOT

API pública MOT

Este é o código-fonte de uma API que fornece acesso a dados MOT públicos.

Ele foi escrito como um conjunto de AWS Lambdas, destinado a ser conectado aos endpoints do AWS API Gateway.

Há alguma cobertura de testes de unidade, focada nos caminhos de código mais importantes para endpoints usados ​​com frequência.

Este repositório usa git-secrets para evitar que segredos sejam confirmados. Certifique-se de ter o git-secrets instalado em sua máquina: https://github.com/awslabs/git-secrets#installing-git-secrets

Construindo e executando TAPI localmente

Pré-requisito

• Java 8/JDK8

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

• Banco de dados MTS instalado e funcionando

• MOTH rodando localmente - https://github.com/dvsa/mot-history

• Execute cp .env.example .env no diretório raiz - isso criará um arquivo .env usando o arquivo de exemplo.

• No .env , altere as seguintes variáveis: –

• MOTH_API_URL: "http://docker.for.mac.localhost:3010" para usar a API MOTH localmente

• MOTH_API_URL e o MOTH_API_KEY correspondente para usar a API MOTH diretamente.

Construir

Para construir o aplicativo, certifique-se de estar no diretório raiz e então:

sam build

Correr

Para executar o aplicativo localmente, certifique-se de ter uma compilação bem-sucedida enquanto estiver no diretório raiz e então:

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

Isso iniciará o aplicativo em http:://127.0.0.1:3000 .

NOTA: Se desejar alterar o número da porta para, por exemplo, 3001, use -p <port_number> .

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

Todos os caminhos e ambientes estão listados no arquivo template.yaml . Os valores das variáveis ​​de ambiente estão listados no arquivo .env .

Você pode adicionar/editar variáveis ​​de ambiente e caminhos conforme mostrado abaixo:

template.yaml:

 Environment :
        Variables :
          MOTH_API_URL :
          MOTH_API_KEY :

.env:

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

Você pode editar/adicionar endpoints:

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

Cada vez que você editar o código ou template.yaml / .env você precisará construir: sam build e executar o aplicativo: sam local start-api --env-vars .env para ver as alterações.