php - APIでの応答オブジェクトの記述-Explorer/Swagger

Question

Swagger-UIのフォークであるRestler3のAPI-Explorerを使用していますが、APIが返す応答JSONオブジェクトを文書化/説明する効果的な方法を誰かが見つけたかどうか疑問に思っています。明らかに、APIをインタラクティブに試してみると、「行間を読む」ような方法でこの一部を利用できますが、応答の構造をより詳細に示す方法が必要です。誰かがこれのために何かを思いついたことがありますか？

Answer 1

@returnPHPDoc コメントでそれを行います。

例については、エクスプローラーの レート制限の例をご覧ください。

GET authors.json/{id}

応答情報のリストが表示されます

Author ( name: string, email: string )

戻り値の型として設定された次のクラスから来ています

<?php
/**
 * Dummy class, used only for creating swagger spec model (json schema)
 * look at the generated resources json to understand
 */
class Author
{
    public $name='Name';
    public $email='name@domain.com';
}