{{$api->title}} 接口离线文档

基本信息

{{$api->project->title}}

{{$api->module->title}}

{{$api->title}}

{{$api->requestMethodLabel}}

{{$api->responseFormatLabel}}

{{$api->created_at}}

{{$api->updated_at}}

{{$api->remark}}

接口地址
{{foreach $api->module->project->envs as $env}} {{/foreach}}
{{$env->title}}({{$env->name}}) {{$env->base_url}}{{$api->uri}}
{{if count($api->headerAttributes)}}
Header参数
{{foreach $api->headerAttributes as $header}} {{/foreach}}
参数名 参数类型 参数值 备注说明
{{$header->name}} {{$api->fieldTypeLabels[$header->type]}} {{$header->value}} {{$header->description}}
{{/if}}
请求参数
{{foreach $api->requestAttributes as $request}} {{/foreach}}
参数名 参数标题 参数类型 必填 默认值 备注说明
{{$request->name}} {{$request->title}} {{$api->fieldTypeLabels[$request->type]}} {{$api->requiredLabels[$request->required]}} {{$request->default}} {{$request->description}}
响应参数
{{foreach $api->responseAttributes as $response}} {{/foreach}}
参数名 参数标题 参数类型 MOCK规则 备注说明
{{if $response->level}} {{str_repeat('   ', $response->level)}} {{/if}} {{$response->name}} {{$response->title}} {{$api->fieldTypeLabels[$response->type]}} {{$response->mock}} {{$response->description}}
{{include_file name='home/public/copyright'}}