我们如何指出该字段在apidocjs中是可选的/必需的？

Question

我们正在研究expressJS和apidocJS，无法在表格中定义可选字段。我们想更新是否为必填字段，以便用户可以识别参数要求。

示例代码：

 * @apiParam {String} name The User Name.
 * @apiParam {String} email The Email Id.
 * @apiParam {String} password The Users High security Password.
 * @apiParam {String} privilegeRole The Users Privilege Role.

Answer 1

$getAllRequirementRecord = Requirement::with('RequirementLocation')->get();
foreach($getAllRequirementRecord as $a){
    $recruiter_count = RequirementRecruiter::select('agency_id','requirement_id')    
        ->where('requirement_id',$a->id)->distinct('agency_id')->count('agency_id');

    $candidate_count = CandidateReferance::select('candidate_id','requirement_id')
        ->where('requirement_id',$id)->distinct('candidate_id')enter code here
        ->count('candidate_id');
}

字段名称中的方括号表示该字段在 apidoc

  

[field]-带括号的字段名称将变量定义为可选。