MOT公共API
这是提供对公共 MOT 数据访问的 API 的源代码。
它被编写为一组 AWS Lambda,旨在连接到 AWS API Gateway 端点。
有一些单元测试覆盖范围,重点关注常用端点的最重要的代码路径。
该存储库使用 git-secrets 来防止提交机密。请确保您的计算机上安装了 git-secrets:https://github.com/awslabs/git-secrets#installing-git-secrets
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
以查看更改。