ElixirでPAY.JPのライブラリ作成シリーズ①

今年もQiitaのアドベントカレンダーの季節がやってきましたね。
東京にいるfukuokaexのYOSUKEこと中尾瑛佑です。

最近は、コードを書く機会が減ったのでこの時期にリハビリを兼ねてがっつり書いていこうと思いますが、リハビリかねてるので記事も丁寧いに少しづつ進行していこうかなと思います。w

こちらの続きです。

PAY.JPのElixirライブラリPayjpex

Payjpexというライブラリ名にしたいと思います。
早速プロジェクトを立てていきましょう。

mix new payjpex

生成したら、恐らく使うであろうライブラリを追加しておきます。

mix.exs ファイルに必要なライブラリを追加します。

  defp deps do
    [
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:ex_doc, "~> 0.27", only: :dev, runtime: false},
      {:dialyxir, "~> 1.0", only: [:dev], runtime: false},
      {:jason, "~> 1.4"},
      {:finch, "~> 0.13"},
      {:tesla, "~> 1.4"}
    ]
  end

追記したら早速取得しておきましょう。

mix deps.get 

ちなみに、ライブラリの説明を簡素にすると以下です。

credo

コードの品質チェックツール
コーディング規約違反などを検出

ex_doc

ドキュメント生成ツール
@moduledocや@docからHTMLドキュメントを生成

dialyxir

型チェックツール
コードの型の問題を静的解析で検出

jason

JSONパーサー/エンコーダー
APIとのJSON通信に使用

finch

HTTPクライアント
高性能なHTTP通信を提供

tesla

HTTPクライアントフレームワーク
APIクライアント構築を簡単にする

only: :devやruntime: falseの解説

only: :dev → 開発時のみ使用
runtime: false → コンパイル時のみ必要