{{$user_id = $project.user_id}} {{$project.title}}接口离线文档——{{get_config('name')}}
基本信息

{{$project.title}}

{{_uri('user', $user_id, 'name')}}({{_uri('user', $user_id, 'email')}})

{{$project.add_time}}

{{$project.update_time}}

{{date('Y-m-d H:i:s')}}

{{$project.intro}}

{{foreach $modules as $k => $module}} {{$module_id = $module.id}}

{{$module.title}}

{{$apis = \app\api::get_api_list($module_id)}} {{foreach $apis as $k => $api}} {{$api_id = $api.id}}

{{$k+1}}、{{$api.title}}

  • {{foreach $envs as $env}} {{/foreach}}
    {{$env.title}}({{$env.name}}) {{$env.domain}}/{{$api.uri}}
    模拟环境(mock) {{url("mock/{{id_encode($api.id)}}", '', true)}}
  • {{\app\api::get_method_list($api.method)}}

  • {{$api.intro}}

  • {{$header_fields = \app\field::get_field_list($api_id, 3)}} {{foreach $header_fields as $header_field}} {{/foreach}}
    字段键 字段值 备注说明
    {{$header_field.name}} {{$header_field.default_value}} {{$header_field.intro}}
  • {{$request_fields = \app\field::get_field_list($api_id, 1)}} {{foreach $request_fields as $request_field}} {{/foreach}}
    字段别名 字段含义 字段类型 是否必填 默认值 备注说明
    {{$request_field.delimiter}}{{if $request_field.parent_id}}--{{/if}}{{$request_field.name}} {{$request_field.title}} {{\app\field::get_type_list({{$request_field.type}})}} {{if $request_field.is_required}}是{{else}}否{{/if}} {{$request_field.default_value}} {{$request_field.intro}}
  • {{$response_fields = \app\field::get_field_list($api_id, 2)}} {{foreach $response_fields as $response_field}} {{/foreach}}
    字段别名 字段含义 字段类型 备注说明
    {{$response_field.delimiter}}{{if $response_field.parent_id}}└{{/if}}{{$response_field.name}} {{$response_field.title}} {{\app\field::get_type_list({{$response_field.type}})}} {{$response_field.intro}}
{{/foreach}}
{{/foreach}}

{{get_config('copyright')}}