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