Amplify Docs のカテゴリ間の行き来をちょっとだけやりやすくするための相関早見表 (2020/12/17版)

こちらは、 “ゆるWeb勉強会@札幌 Advent Calendar 2020” の 17日目の記事です。

AWS Amplify の機能はかなりの勢いで追加されており、それに応じてドキュメントも日々拡充されています。

Amplify Framework Docs Learn how to use Amplify to develop and deploy cloud-powered mobile and web apps
Amplify Framework Docs docs.amplify.aws
Amplify Framework Docs

で、 Amplify で開発するときって CLI で行なうのでどうしても CLI カテゴリを中心に読んでいたのですが(それでも読みきれない量になってきた)、色々と詰まってきたときに実は Libraries カテゴリを読むと欲しい情報が詰まっていた、、ということが最近よくありました。

というわけで、ドキュメントのカテゴリ CLILibrariesUI Components の中で、「同じ機能」を横断的に説明しているものが紐づくようなリストを作っておきたいと思います。

ついでに、 Gides カテゴリと AWSのサービスとの(簡易的な)相関も入れます。

カテゴリ間相関早見表

CLILibrariesUI ComponentsGuidesAWS Services
AnalyticsPinpoint, Kinesis
API (GraphQL)API (GraphQL), DataStoreAPI (GraphQL)AppSync
@modelDynamoDB
@auth → Authentication
@function → Functions
@predictionsPredictionsAI / ML
@searchableElasticsearch
API (REST) → FunctionsAPI (REST)API (REST)API Gateway, Lambda
AuthenticationAuthenticationAuthenticationAuthenticationCognito
InteractionsInteractionsLex
PubSubIoT
Push NotificationsPinpoint
Storage – S3StorageStorageS3
Storage – NoSQLDynamoDB
XRSumerian
FunctionsFunctionsLambda
HostingHostingCloudFront, S3

完全とは言えないかもしれませんが、現時点ではこのような感じで情報が配置されています。

CLI で「コマンド操作するときにどうするか」、
Guides や Libraries で「こういうことをやりたいけどどうやるか」、
UI Components で「画面と連携するときどうやるか」、
ということが読めると思います。

例えば認証だと、実際に下記のような流れで操作しつつドキュメントの参照をしたりしています。

  • CLI の Authentication を参考に機能追加
  • Libraries を見ながらメールベース認証と OAuth 認証の流れを確認し設定
  • UI Components を見ながら画面へ要素を配置して入力項目の設定

この辺りが固まっていてくれると嬉しいと思う反面、現在の分け方の観点も悪いとは思わないのでなかなか難しいですね。

こういった情報をオフィシャルとは別でまとめるのも、個人的には有用だと思います。

気づいたことは、ボチボチと記録を残していこうと思います。

コメントする

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください