yubinbango

module

v0.0.0-...-007c033 Latest Latest Go to latest Published: May 4, 2024 License: MIT

Details

郵便番号CSVファイルへのアクセスを容易にするためのユーティリティ

郵便番号CSVファイルをダウンロードします。
zipファイルをダウンロードして展開したCSVファイルを出力します。

パラメータ	短縮	デフォルト	説明	例
--output	-o	data	出力ディレクトリパス CSVファイルの保存先	yubindango dl -o=data
--jigyosyo	-j	https://www.post.japanpost.jp/zipcode/dl/jigyosyo/zip/jigyosyo.zip	事業所CSVのダウンロードURL	yubinbango dl -j=https://...
--ken-all	-k	https://www.post.japanpost.jp/zipcode/dl/utf/zip/utf_ken_all.zip	ken-allのダウンロードURL	yubinbango dl -k=https://...

$ yubinbango dl -o 出力ディレクトリパス -j 事業所データフラグ

郵便番号CSVファイルを読み込み、JSON形式に変換します。

パラメータ	短縮	デフォルト	説明	例
--path	-p	./data/.csv,./data/.CSV	CSVファイルパス変換対象のCSVファイルパス	yubinbango c2j -p=./data/*/.csv
--output	-o	./data/output/json	出力ディレクトリパス JSONファイルの保存先	yubinbango c2j -o=./data/output/json
--renew	-r	false	再作成フラグ JSONファイルを再作成する	yubinbango c2j -r

$ yubinbango c2j -p CSVファイルパス -o 出力ディレクトリパス -r 再作成フラグ

JSON形式のファイルを読み込み、JSONP形式に変換します。

パラメータ	短縮	デフォルト	説明	例
--path	-p	./data/output/json	JSONファイルパス変換対象のJSONファイルパス	yubinbango j2j -p=./data/output/json
--output	-o	./data/output/js	出力ディレクトリパス JSONPファイルの保存先	yubinbango j2j -o=./data/output/js

$ yubinbango j2j -p JSONファイルのディレクトリパス -o 出力ディレクトリパス

指定したJSON、JSONP形式のファイルを読み込み、レスポンスを返すAPIサーバーを起動します。

パラメータ	短縮	デフォルト	説明	例
--data	-d	file://data/output/	データディレクトリパス JSON、JSONPファイルのディレクトリパス	yubinbango server -d=./data/output
--health	-h	false	ヘルスチェック有効フラグヘルスチェック用APIを有効化する	yubinbango server -h
--basic	-b		ベーシック認証ユーザーパスワード `username:password` の形式でユーザー/パスワードを設定する	yubinbango server -b=username:password
--basic-auth	-B	false	ベーシック認証有効化フラグベーシック認証を有効化する	yubinbango server -B

./api ディレクトリにAPIの仕様書を格納しています。

$ yubinbango server -d データディレクトリパス -h ヘルスチェック有効フラグ　-b ベーシック認証ユーザーパスワード -B ベーシック認証有効化フラグ