README

postalianは自分用の郵便番号APIサーバーの作成・公開を支援するスケルトンです。

必須条件

PHP 7.0+
Lumen 5.5.*
Guzzle 5.3.*

インストール

Composer

$ composer create-project --prefer-dist ticknical/postalian [your project name]

使用方法

郵便番号CSVの取り込み

日本郵便からのCSVダウンロード・取り込み・取得前後のデータ加工までをコマンド一発で行います。

$ php artisan postalcode:storeall

ダウンロードした郵便番号CSVについては、少しデータを加工して取り込んでいます。

町域名が多すぎて複数行に分割されている場合はマージ
「以下に掲載がない場合」を空文字へ置換
「＊＊の次に番地がくる場合」を空文字へ置換
「＊＊一円」を空文字へ置換

簡単な郵便番号API

簡単な郵便番号APIを公開できます。

例えばhttp://[domain]/api/search/code/1000001にアクセスすると、以下のJSONが返却されます。

{
    "status": true,
    "version": "2017-10-31",
    "postal_codes": [
        {
            "postal_code": "1000001",
            "prefecture": "東京都",
            "city": "千代田区",
            "street": "千代田"
        }
    ]
}

ticknical / postalian

Maintainers

Details