shibuyakosuke/laravel-postalcode-japan

郵便番号データを取り込んで住所マスタを作成します。

2.0.5 2023-12-14 07:57 UTC

This package is auto-updated.

Last update: 2024-04-14 08:56:55 UTC


README

郵便番号データを取り込んで住所マスタを作成します。

Install

composer require shibuyakosuke/laravel-postalcode-japan

Setup

マイグレーションを実行します。

php artisan migrate

postal_codes, cities, prefectures テーブルが作成されます。

php artisan postalcode:update

を実行すると、自動的に郵便番号データをダウンロードし、 各テーブルにデータを投入します。同じコマンドを再度実行しても、cities, prefectures のデータは updateOrCreate() で更新されます。

また、テスト環境などで全都道府県のデータまでは不要な場合、--test オプションをつけて実行することで、東京都のデータのみを投入することもできます。

Usage

あらかじめルートが設定されており、ajax/prefectures/ にアクセスすると都道府県の一覧、ajax/cities/{prefecture} にアクセスすると市区町村の一覧をJSONデータで取得することができます。