pahanini / yii2-rest-doc Goto Github PK

<?php

/**
 * A class.
 *
 * @property int $id ID
 * @property string $name Some name
 */
class A extends \yii\db\ActiveRecord {

  /**
   * @restdoc-link $id
   * @restdoc-link $name
   */
  public function fields() {
    return [
      'id',
      'name',
    ];
  }
}

<?php

/**
 * @inheritdoc
 */
class B extends A {

  /**
   * @inheritdoc
   * @restdoc-field string $created_at Date of create
   */
  public function fields() {
    return [
      'id',
      'name',
      'created_at',
    ];
  }
}

/**
 * Test Controller
 *
 * @restdoc-label Test controller
 *
 */
class TestController extends Controller
{
    public function behaviors()
    {
        $behaviors = parent::behaviors();
        $behaviors['authenticator'] = [
            'class' => \yii\filters\auth\CompositeAuth::className(),
            'authMethods' => [
                \yii\filters\auth\HttpBasicAuth::className(),
                \yii\filters\auth\HttpBearerAuth::className(),
                \yii\filters\auth\QueryParamAuth::className(),
            ],
        ];
        return $behaviors;
    }

    /**
     * Gets users profile info
     *
     * @return Profile
     *
     * @throws NotFoundHttpException
     */
    public function actionProfile()
    {
        return $this->findModel(Yii::$app->user->identity->id)->profile;
    }

    /**
     * Creates new entry of [[Network]] for current user
     *
     * << REST API USAGE >>
     *
     * @restdoc-field int $network Type of network from special list of networks
     * @restdoc-field string $access_token Access token received from social network
     * @restdoc-field string $secret_token Secret token received from social network
     * @restdoc-field string $refresh_token Refresh token received from social network
     * @restdoc-field string $token_type Token type received from social network
     * @restdoc-field string $network_user_id Id of user in current network
     * 
     * @return string If success
     */
    public function actionAddNetwork()
    {
        Network::deleteAll([
            'user_id' => Yii::$app->user->identity->id,
            'network' => Yii::$app->request->post('network'),
        ]);

        $social = new Network();
        $social->user_id = Yii::$app->user->identity->id;

        $social->load(Yii::$app->request->getBodyParams(), '');

        if ($social->save()) {
            return ['success' => true];
        }

        return $social;
    }

    public function findModel($id)
    {
        if (($model = User::findOne($id)) !== null) {
            return $model;
        } else {
            throw new NotFoundHttpException("Object not found");
        }
    }
}

/**
 * A class.
 * 
 * @property int a `a` field 
 * @property int b `b` field
 * @property int c `c` field
 */
class A extends ActiveRecord {

  /**
   * @restdock-link a
   * @restdock-link b
   */
  public function fields()
  {
    return [
      'a',
      'b',
    ];
  }

  public function rules(){
    return [
      ['a', 'required'],
      ['c', 'required'],
    ];
  }
}

<?php
/**
 * A class.
 */
class A extends \yii\db\ActiveRecord {

  /**
   * @restdoc-field int $id ID
   * @restdoc-field string|null $name Some name
   */
  public function fields() {
    return [
      'id',
      'name',
    ];
  }
}