sukohi / laravel-jp-postal-code
A Laravel package that allows you to search address with Japanese postal code.
Installs: 1 416
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 7
Open Issues: 0
Requires
- illuminate/support: ^5.7|^6.0
This package is auto-updated.
Last update: 2024-11-10 21:53:23 UTC
README
A Laravel package that allows you to search address with Japanese postal code.
(This package is maintained under Laravel 5.7.)
Installation
Run the following command.
composer require sukohi/laravel-jp-postal-code:1.*
Preparation
The migration file is automatically loaded.
So just run this command.
php artisan migrate
And download "ken_all.zip" from the below by clicking "全国一括".
Set a csv file in /storage/app/csv/KEN_ALL.CSV
after unzip.
Now the time to import postal data.
Run this command.
php artisan import:jp-postal-code
Note: Import takes time because the csv file has over 120,000 lines.
Configuration
If you'd like to configure, publish jp_postal_code.php
.
php artisan vendor:publish --provider="Sukohi\LaravelJpPostalCode\LaravelJpPostalCodeServiceProvider"
Now you have jp_postal_code.php
in /config
folder.
endpoint
This is URL that provides feature of address search.
So you can search Japanese address as follows though Ajax.
- /api/jp_postal_code?code=131-0045
- /api/jp_postal_code?first_code=131&last_code=0045
Multi-byte character like "1310045" is also available.
[Response example]
{
address: "押上"
city: "墨田区"
first_code: "131"
full_address: "〒131-0045 東京都墨田区押上"
full_code: "131-0045"
id: 39342
last_code: "0045"
prefecture: "東京都"
}
- You can change format of
full_address
andfull_code
in/config/jp_postal_code.php
.
import_path
The path of "KEN_ALL.CSV".
address_format
The format of full_address
when retrieving address.
postal_code_format
The format of full_code
when retrieving address.
License
This package is licensed under the MIT License. Copyright 2019 Sukohi Kuhoh