ApiDocの使用

この記事では ApiDoc の使い方を紹介します。興味のある方はぜひご覧ください

説明

apiDoc creates a documentation from API annotations in your source code

apiDoc はインターフェイス ドキュメントであり、その作成方法はソース コードのインターフェイス ノートに基づいています。必要なのは、インターフェイスに対応するドキュメントを作成し、その後、apiDoc 生成インターフェイス ドキュメント ツールを使用して、管理と表示を容易にするドキュメントを生成することだけです。

設定方法

1. apidoc をインストールします (npm とは??? フロントエンドのクラスメイトに聞いてください...)

npm install apidoc -g

http-server をインストールします

npm install http-server -g

2. インターフェースにドキュメントを追加します。公式の例) を、Controller エントリ メソッドの前に追加します。

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */

3. apidoc.jsonを作成する(公式サンプル)

{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "apidoc": {
    "title": "Custom apiDoc browser title",
    "url" : "https://api.github.com/v1"
  }
}

4. apiDocを生成する

apidoc -i app/Http/Controllers -o apidoc/

補足

参考

s.com/

以上がApiDocの使用の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。