WordPressのREST APIをドキュメント化してくれるプラグインを作りました
WordPress4.7から採用されたREST APIですが、ぼちぼちプラグインの方でも対応が進んできました。また、弊社の案件でも特定のサイト向けに専用のAPIを作成することが増えてきました。自分たちが作ったものならともかく、APIだと「え、そんなエンドポイントあったの？」ということもままあります。
そんなわけで、ざっとブラウジングできると便利なのではないかと思ってプラグインを作りました。
このプラグインを有効化すると、管理画面のツール > REST API のところにドキュメントが表示されます。もちろん、プラグイン側でちゃんと書いていなかったら意味ないんですが、それなりに役に立つのではないでしょうか。
フロントエンドエンジニア向け
さて、最近はReactやVueJSなどのフレームワークを使ってサイトを作るのが得意な人たちから「バックエンドだけ作ってね」という依頼を受けることも増えてきました。いわゆるSPA案件ですね。
そんなとき、REST APIを作った後、Swaggerでドキュメントを残したりする必要性が出てくるのですが、私はSwaggerのマニュアルを見ただけで「つ、辛ぁ……」と思ってしまったので、一回コード書いたら「あとはここ見てください！」で終わると嬉しいなと思ってこのプラグインを作りました。
今後の予定
やるかどうかはわかりませんが、こんな機能を予定しています。
- インクリメンタルサーチ（エンドポイント検索）
- 返り値の指定（いまは返り値が不明）
Githubリポジトリはこちら。イシューやプルリクお待ちしています。
