なにがでるか

先日、SendGridのドキュメントに新しいAPIドキュメントが追加されました。元々、APIリファレンスに相当するドキュメントは存在していたのですが、 StopLight というサービスの機能を使ってより使いやすく整理した、といったところでしょうか。 入り口 新しいドキュメントの入り口はちょっとわかりづらくて、 ドキュメントのトップページ 上にある「 SendGrid API 」というリンクです。 主な特徴 次に、この新しいAPIドキュメントの特徴をまとめてみます。 リクエストとレスポンスがちゃんと定義された 今まで定義されてなかったのかよ、って感じですが、 これまで はリクエストについては概ね定義されていましたが、レスポンスはほとんど定義されていませんでした。レスポンスの例は載っていたので特に不都合はなかったのですが、ちゃんとした定義があるに越したことはありませんね。 Swagger(OAS)/RAMLによる定義が公開された StopLightの機能の一つですが、APIの定義全体がSwagger形式とRAML形式で公開されています。これがあると、 SendGridのAPIサーバのモックを作ってテストに利用 するといったことができるようになります。 APIドキュメントからリクエストのテストができるようになった これもStopLightの機能の一つのようですが、各エンドポイントのページの「 Try it out 」タブを選択するとドキュメントからAPIのリクエストを送信して結果確認ができます。使い方はとても簡単で、必要なパーミッションを持ったAPIキーをYOUR_API_KEYパラメータに設定、リクエストJSONをBodyに指定して「 SEND REQUEST 」ボタンを選択するだけです。 コード生成ができるようになった 「 Try it out 」でリクエストを送信すると、代表的な言語のコード生成ができるようになります。「 Code Generation 」から一通りのプログラミング言語およびコマンドのサンプルコードが確認できるので、サッとコピペして使えます。 PostmanにSwaggerの定義ファイルを喰わせてみる Swaggerの定義 が公

はじめに 10日ほど前の話になりますが、 sendgrid-kintone-plugin というkintoneからSendGrid経由でメールを一斉送信するプラグインを更新しました。最近物忘れがひどいので、やったことをまとめておこうと思います。 基本事項 このプラグインは、kintone上に保存したDBを宛先リストに見立てて、SendGrid経由で一斉配信する、というコンセプトで作られています。一覧画面に表示されたものが送信対象となり、送信するメールの内容はSendGridのテンプレート機能で管理します。フィルタを適用することで宛先リストの絞り込みもできます。 更新内容 今回更新したバージョンは「バージョン4」となります。ユーザ視点からすると大きな変化はありませんが、実はほぼ全面実装し直しています。一応、変更点は Change Log にまとめてありますが、たぶんわかりづらいので個別に説明します。 宛先フィールドに必須項目、値の重複を禁止の制限を加えました 宛先として指定可能なフィールドに「 必須項目にする 」と「 値の重複を禁止する 」の条件を追加しました。これまではこのような制限は明確には課していませんでしたが、SendGridのAPIの制約上、宛先フィールドは指定が必須で、ユニークである必要があるので、これに合わせてkintone側にも同じ条件を強制するようにしました。プラグインを新しいものに更新すると、 この設定がないフィールドは 宛先用フィールドとして選択できなくなっているので、フィールドの設定を変更する必要があります。 新デザイン対応 kintoneの新デザイン にプラグインのデザインを合わせました。機能的には変更はありません。ボタンやドロップダウンがそれっぽい表示になりました。ついでにテンプレートの編集画面にも飛べるようリンクをはりました。 新SendGridロゴ SendGridのロゴ を新しいものに差し替えました。 送信者名の指定が可能に 送信者名の指定に対応しました。 From: 送信者たろう＜hoge@example.com＞ みたいなメールが送れるようになりました。 Web API v3のメール送信用エンドポイント