#!/usr/bin/env python3 """ 04 - Flask API 速查手册（可直接运行） 本文件是 Flask 路由、请求、响应、模板等核心 API 的速查参考。 可以直接运行后在浏览器中查看所有 API 的实时演示。 运行方式： python3 04-api-quickref.py 访问： http://localhost:5000/ —— 首页（API 速查索引） """ from flask import Flask, request, jsonify, make_response, redirect, url_for, render_template_string from datetime import datetime app = Flask(__name__) app.config['JSON_AS_ASCII'] = False INDEX_HTML = ''' Flask API 速查

🚀 Flask API 速查手册

当前时间: {now} | 服务器: Flask {version}

📌 路由系统

API说明示例
@app.route('/')基本路由测试 →
@app.route('/<name>')动态路由（字符串）测试 →
@app.route('/<int:id>')动态路由（整数）测试 →
methods=['GET','POST']限制 HTTP 方法测试 →

📌 请求对象

属性/方法说明测试
request.args.get('key')查询参数测试 →
request.headers请求头测试 →
request.method请求方法测试 →
request.remote_addr客户端 IP测试 →

📌 响应方式

方式代码测试
字符串return 'Hello'测试 →
JSONreturn jsonify(data)测试 →
重定向return redirect(url)测试 →
自定义头make_response()测试 →
404abort(404)测试 →

📌 URL 构建

函数说明
url_for('index')生成 '/' 的 URL
url_for('show_demo', name='test')生成 '/demo/test'
url_for('static', filename='css/style.css')生成 '/static/css/style.css'
''' @app.route('/') def index(): return render_template_string(INDEX_HTML, now=datetime.now().strftime('%Y-%m-%d %H:%M:%S'), version='3.x') @app.route('/demo/basic') def demo_basic(): return '

✅ 基本路由

这是 @app.route("/") 的效果

← 返回' @app.route('/demo/') def show_demo(name): return f'

✅ 动态路由

捕获的变量: {name}

类型: {type(name).__name__}

← 返回' @app.route('/demo/') def show_number(num): return f'

✅ 整数路由

捕获的整数: {num}

运算: {num} × 2 = {num * 2}

← 返回' @app.route('/demo/methods', methods=['GET', 'POST']) def demo_methods(): return f'

✅ 多方法路由

当前请求方法: {request.method}

← 返回' @app.route('/demo/request') def demo_request(): args = dict(request.args) return f'''

✅ 请求对象

method{request.method}
path{request.path}
url{request.url}
remote_addr{request.remote_addr}
查询参数{args}
← 返回 ''' @app.route('/demo/headers') def demo_headers(): headers = dict(request.headers) rows = ''.join(f'{k}{v}' for k, v in sorted(headers.items())[:15]) return f'

✅ 请求头

{rows}
← 返回' @app.route('/demo/text') def demo_text(): return '

✅ 返回字符串

Flask 自动包装为 text/html 响应

← 返回' @app.route('/demo/json') def demo_json(): return jsonify({ 'status': 'ok', 'message': '这是 JSON 响应', 'endpoint': '/demo/json', 'params': dict(request.args), }) @app.route('/demo/redirect') def demo_redirect(): return redirect(url_for('index')) @app.route('/demo/custom') def demo_custom(): resp = make_response('

✅ 自定义响应

查看响应头的 X-Custom 字段

← 返回') resp.headers['X-Custom-Header'] = 'hello' resp.headers['X-API-Version'] = '3.0' return resp @app.route('/demo/abort-404') def demo_abort(): from flask import abort abort(404) if __name__ == '__main__': print("🚀 Flask API 速查手册启动...") print(" 访问 http://127.0.0.1:5000/") app.run(debug=True, host='127.0.0.1', port=5000)