@kyanny's blog

My thoughts, my life. Views/opinions are my own.

PagerDuty の API リファレンスがよくできている

https://developer.pagerduty.com/api-reference/

ブラウザ上で各種パラメータを変えながらリクエストを発行できる。試行錯誤しやすくて便利。結果の表示形式も pretty print JSON やネストされた Object を開閉できるやつ(Chrome console みたいな感じ)などから選べて使い勝手が良い。

自分の API キーを使うこともできる。画面左上の "Test API Token" のところに自分の API キーを入れれば良い。 API キーの発行方法は Generating API Keys 参照。自分の API キーを使うと所属してる組織のデータにアクセスできるのでいろいろ試しやすい。

f:id:a666666:20210305014832p:plain

自動コード生成も意外に便利だった。自分で API を書く場合、仕様も使い方も頭に入っているのでわざわざ OpenAPI のようなドキュメントからコード生成するメリットがピンとこなかったが、 API のユーザーの立場だと、動作するコードをワンクリックで手に入れられるのは便利だ。それを出発点にして開発し始めると、 boilerplate なコードを書く手間と時間が節約できる。

このページ、 OpenAPI (Swagger UI) には見えないし、 Postman の UI ともちょっと違う。 Postman の OEM っぽい気もするけど、もし自前で作ってるとしたら相当しっかり作ってあるなあと思う。