第1章 Liquid リファレンス

1.1. Liquid とは

Liquid はシンプルなプログラミング言語で、API プロバイダが利用可能な 3scale システムからのデータのほとんどを表示および処理するのに使用されます。Liquid は元来 Shopify が開発したもので、Web を通じて他の多くのコンテンツ管理システム (CMS) エンジンで使用されています。3scale プラットフォームでは、これを使用してサーバー側のデータを API 開発者に公開し、高いセキュリティーレベルを維持しながらデベロッパーポータルの有用性を大幅に向上させています。

1.1.1. メリットとデメリット

Liquid は、主にサーバー側のデータを取得してデベロッパーポータルのページに表示するのに使用されます。しかし、Liquid にはこれ以外にも多くの機能があります。以下の用途にも使用することができます。

  • サーバー側のデータに基づきページの DOM およびコンテンツを変更する。
  • ページ、パーシャル、およびレイアウトにロジックを追加する。
  • 開発者に送信されるメールのテンプレートを操作する。

Liquid が問題解決の最適解を提供しないケースもあります。主に、ユーザーからのインプットやページの URL 等の動的なデータを使用しなければならない場合です。

一般的なアドバイスとしては、ページにロジックを追加する手段として先ず Liquid を使用し、不可能である、または過度に複雑になることが分かったら、JavaScript に切り替える、あるいは JavaScript に Liquid を追加する (Liquid は JS との組み合わせでも適切に機能するため) ことを推奨します。