https://github.com/casl0/japanpost_api
郵便番号検索サーバーレスAPI
https://github.com/casl0/japanpost_api
api-gateway aws aws-lambda cdk lambda s3-select
Last synced: 15 days ago
JSON representation
郵便番号検索サーバーレスAPI
- Host: GitHub
- URL: https://github.com/casl0/japanpost_api
- Owner: CASL0
- License: mit
- Created: 2024-01-05T10:52:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-09T01:16:58.000Z (about 1 year ago)
- Last Synced: 2025-03-09T02:19:52.044Z (about 1 year ago)
- Topics: api-gateway, aws, aws-lambda, cdk, lambda, s3-select
- Language: TypeScript
- Homepage:
- Size: 436 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# japanpost_api
[](https://github.com/CASL0/japanpost_api/actions/workflows/test.yaml)
[](https://github.com/CASL0/japanpost_api/actions/workflows/lint.yaml)
[](https://github.com/google/gts)
[](https://opensource.org/license/mit)
[日本郵政の郵便番号データ](https://www.post.japanpost.jp/zipcode/dl/utf-zip.html)を使用した郵便番号検索APIの構築をします。
## Requirements
以下の環境変数を設定してください。
- AWS_ACCESS_KEY_ID
- AWS_SECRET_ACCESS_KEY
- AWS_DEFAULT_REGION
## Getting Started
VSCode で本プロジェクトを開き、コマンドパレット（Ctrl+Shift+P）から[Dev Containers: Reopen in Container...]を実行し、下記コマンドを実行してください。
```sh
yarn compile src/handler.ts
yarn cdk deploy
```
デプロイ完了です。
API Gatewayのサービスエンドポイントを確認し、APIをリクエストしてください。
```sh
curl http://example.com?zipcode=1010065
```
以下のレスポンスが返ってきます。
```json
[
{
"jisCode": "13101",
"oldZipCode": "101 ",
"zipCode": "1010065",
"prefectureKatakana": "トウキョウト",
"cityKatakana": "チヨダク",
"townKatakana": "ニシカンダ",
"prefecture": "東京都",
"city": "千代田区",
"town": "西神田"
}
]
```
## 構成
API Gateway を Lambda と統合し、Lambda から S3 Select を呼び出して CSV から住所検索をします。
- API Gateway
- Lambda
- S3
### 詳細
1. 日本郵政の Web サイトから CSV をダウンロードします。
-
1. S3 のバケットを作成し、上記でダウンロードした CSV を配置します。
1. ラムダを作成し、aws-sdk を使って、S3 Select による住所検索をします。
- 512 MiB
- Node 16
1. 先に作成したバケットの読み取り権限をラムダに付与します。
1. API Gateway を作成し、上記のラムダと統合します。