{{doc.title}}
- Version:
{{doc.version}}
- Host:
{{doc.host}}
%if language == 'zh': 接口目录: %else: Contents %endif
-
%for api in doc.apis:
- {{api.title}} %endfor
%for note in doc.notes:
{{note.title}}
%endif{{markdown(note.content, escape=False)}}
%endif %for api in doc.apis:
{{api.title}}
%if api.url: %endif %if api.from_md:Path 参数 | 类型 | 描述 | 必须 | 默认值 | 示例 | %else:Path Parameters | Type | Description | Required | Default | Example | %endif
---|---|---|---|---|---|---|---|---|---|---|---|
{{param.name}} |
{{param.type}} | {{param.description}} | {{param.required_svg}} | {{param.default}} | {{param.example}} |
Query 参数 | 类型 | 描述 | 必须 | 默认值 | 示例 | %else:Query Parameters | Type | Description | Required | Default | Example | %endif
---|---|---|---|---|---|---|---|---|---|---|---|
{{param.name}} |
{{param.type}} | {{param.description}} | {{param.required_svg}} | {{param.default}} | {{param.example}} |
Body 参数 | 类型 | 描述 | 必须 | 默认值 | 示例 | %else:Body Parameters | Type | Description | Required | Default | Example | %endif
---|---|---|---|---|---|---|---|---|---|---|---|
{{param.name}} |
{{param.type}} | {{param.description}} | {{param.required_svg}} | {{param.default}} | {{param.example}} |
%if language == 'zh':
传参可用的
%else:
Body
%endif
Content-Type
:
%for t in api.content_types:
{{t}}
%endfor
%if language == 'zh': 示例请求数据: %else: Request Body Example: %endif
{{api.body_example.strip()}}
%endif
%if api.response_description:
%if language == 'zh': 返回结果说明: %else: Response Description: %endif
{{markdown(api.response_description, escape=False)}} %endif %if api.response_example:%if language == 'zh': 示例返回结果: %else: Response Example: %endif
{{api.response_example.strip()}}
%endif
%if api.tips:
%endfor %if doc.ending:
{{markdown(doc.ending, escape=False)}}
%endif