こんにちは、フルスタックエンジニアのryuです。
今回の記事は、strapiでAPIのドキュメントを自動で生成する方法を解説します。APIのドキュメントを自動で生成するためにはプラグインをインストールします。プラグインをインストールするだけでドキュメントを自動生成してくれるので便利です。
目次
strapiでAPIのドキュメントを自動で生成する方法解説
APIの仕様書を作成するのがめんどくさい
今回の記事では、strapiでAPIのドキュメントを自動で生成する方法を解説します。API仕様書の作成がめんどくさいと思う方にオススメです。
設定方法は簡単で、document pluginをインストールするだけです！
では、手順を詳しく解説します。
準備:strapiをインストールしてAPIを作成する
まず、strapiをインストールしてAPIを作成しましょう。
今回はブログの記事を取得するAPIを想定しております。
「http://localhost:1337/articles」とGETすると下記のような情報が取得できるAPIを作成しましょう。
詳しい作成方法は、こちらの記事で解説しています。
ドキュメントを自動生成するプラグインをつかってみよう！
StrapiのAPIの準備ができたら、プラグインをインストールしましょう。
strapiでプラグインをインストールする方法
strapiでプラグインをインストールするためには、「マーケットプレイス」をクリックします。
マーケットプレイスの中の「DOCUMENTATION」をダウンロードしましょう。
ダウンロードをクリックすると、「Downloading」と表示されます。ダウンロードが完了するとstrapiは自動的に再起動されます。
プラグインの設定
インストールが完了したら、プラグインの設定を行います。
設定は簡単で、APIのドキュメントを自動生成するサイトにアクセスするパスワードを設定するだけです。
まず、「Documentation」をクリックしましょう。
次に、画面の中央にある「Restricted access」をONにします。そしてパスワードを設定しましょう。
これで設定完了です！
Strapiで自動生成されたDocumentを確認してみよう
先ほど、パスワードを設定した画面の上に「Open the document」というボタンがあります。そちらをクリックしましょう。
クリックすると、パスワードの入力画面が表示されます。先ほど設定したパスワードを入力しましょう。
パスワードを入力すると、以下のように、APIの情報が表示されます。
APIの自動生成は、Swaggerというものを使用しています。Swaggerについては、公式ページを参考にしてください。
API Documentation & Design Tools for Teams | Swagger
strapiでAPIのドキュメントを自動で生成する方法まとめ
今回の記事は、strapiでAPIのドキュメントを自動で生成する方法を解説しました。
英語を読める方は、公式ドキュメントを確認してみてください。strapiはまだ日本語の情報が少ないので、これからも発信していこうと思います。
