zippia

README

zippia

zippia はシンプルな郵便番号検索 API サーバーです。
データベースを内包しているため、バイナリひとつで動作します。

Usage

simplest usage

$ zippia

オプションなしで起動すると、 127.0.0.1:5000 をバインドして HTTP サーバーが立ち上がります。

specify binds host and port

$ zippia --host 0.0.0.0 --port 8080

詳細は zippia -h を確認してください。

API specification

https://tetsu040e.github.io/zippia/ を参照してください

Requirements

go >= 1.18

Installation

use Go

go install github.com/tetsu040e/zippia@latest

use Docker

docker run -it -p 5000:5000 tetsu040e/zippia

use binary file

Releases から最新バイナリをダウンロードしてください。

Update zip code data

郵便番号のデータは概ね1ヶ月ごとに更新されます。
zippia は GitHub Actions を使って定期的に日本郵政のホームページをチェックし、データを更新しています。
go install でインストールした場合は @latest を使って再インストールすることで、最新データを内包したバイナリに更新できます。　　
また、Releases へ定期的に、最新データを内包したバイナリがアップロードされるようになっています。
インストール済みのバイナリ内のデータ最終更新日時は zippia -vv を実行して確認できます。

License

MIT

Author

tetsu040e