创建基于REST风格的简单接口实现远程交互或控制
概述
REST（Representational State Transfer）是一种设计风格，用于构建网络应用程序。它利用标准的HTTP方法（如GET、POST、PUT、DELETE等）来对资源进行操作。本文将介绍如何使用Python创建一个简单的REST风格的Web服务，并通过这个服务提供两个基本功能：问候用户和获取当前时间。我们将使用wsgiref库来搭建服务器，并通过urllib库来测试这些接口。
代码结构
- PathDispatcher类：负责根据请求路径和方法分发请求到相应的处理函数。
- hello_world函数：处理GET请求，返回一个包含用户名的HTML页面。
- localtime函数：处理GET请求，返回当前时间的XML格式数据。
- 主程序：设置并启动WSGI服务器，注册路径和处理函数。
- 客户端测试：使用
urllib库发送请求并打印响应。
代码分析
PathDispatcher类
import cgi
def notfound_404(environ, start_response):
start_response('404 Not Found', [('Content-Type', 'text/plain')])
return [b'Not Found']
class PathDispatcher:
def __init__(self):
self.pathmap = {
}
def __call__(self, environ, start_response):
path = environ['PATH_INFO']
params = cgi.FieldStorage(environ['wsgi.input'], environ=environ)
method = environ['REQUEST_METHOD'].lower()
environ['params'] = {
key:params.getvalue(key) for key in params}
handler = self.pathmap.get((method, path), notfound_404)
return handler(environ, start_response)
def register(self, method, path, function):
self.pathmap[method.lower(), path] = function
return function
PathDispatcher类维护了一个字典pathmap，用于存储不同请求方法和路径对应的处理函数。__call__方法是WSGI应用的核心，它接收环境变量environ和响应头生成器start_response作为参数。- 根据请求的方法和路径，从
pathmap中查找相应的处理函数；如果没有找到，则返回404错误。 register方法允许注册新的处理函数到pathmap中。
处理函数
import time
_hello_resp = '''\
<html>
<head>
<title>Hello {name}</title>
</head>
<body>
<h1>Hello {name}</h1>
</body>
</html>
'''
def hello_world(environ, start_response):
start_response('200 OK', [('Content-Type', 'text/html')])
params = environ['params']
resp = _hello_resp.format(name=params.get('name'))
yield resp.encode('utf-8')
_localtime_resp = '''\
<?xml version="1.0" encoding="UTF-8"?>
<time>
<year>{t.tm_year}</year>
<month>{t.tm_mon}</month>
<day>{t.tm_mday}</day>
<hour>{t.tm_hour}</hour>
<minute>{t.tm_min}</minute>
<second>{t.tm_sec}</second>
</item>
'''
def localtime(environ, start_response):
start_response('200 OK', [('Content-Type', 'application/xml')])
resp = _localtime_resp.format(t=time.localtime())
yield resp.encode('utf-8')
hello_world函数处理GET请求，返回一个包含用户名的HTML页面。localtime函数处理GET请求，返回当前时间的XML格式数据。
主程序
if __name__ == '__main__':
from resty import PathDispatcher
from wsgiref.simple_server import make_server
dispatcher = PathDispatcher()
dispatcher.register('GET', '/hello', hello_world)
dispatcher.register('GET', '/localtime', localtime)
httpd = make_server('localhost', 8000, dispatcher)
print('Serving on http://localhost:8000...')
httpd.serve_forever()
- 创建
PathDispatcher实例，并注册两个处理函数。 - 使用
make_server创建一个WSGI服务器，并在本地8000端口上运行。
客户端测试
import urllib.request
u = urllib.request.urlopen('http://127.0.0.1:8000/hello?name=Guido')
print(u.read().decode('utf-8'))
u = urllib.request.urlopen('http://127.0.0.1:8000/localtime')
print(u.read().decode('utf-8'))
- 使用
urllib.request模块发送GET请求，并打印响应内容。
运行和测试
启动服务器：
python your_script.py你会看到输出：
Serving on http://localhost:8000...测试
/hello接口： 打开浏览器访问http://localhost:8000/hello?name=Guido，或者使用上述客户端代码，你会看到如下HTML页面：<html> <head> <title>Hello Guido</title> </head> <body> <h1>Hello Guido</h1> </body> </html>测试
/localtime接口： 访问http://localhost:8000/localtime，或者使用客户端代码，你会看到如下XML数据：<?xml version="1.0" encoding="UTF-8"?> <time> <year>2024</year> <month>11</month> <day>30</day> <hour>17</hour> <minute>23</minute> <second>16</second> </item>
总结
通过本文，我们展示了如何使用Python和WSGI创建一个简单的REST风格的Web服务。我们实现了两个基本功能：问候用户和获取当前时间，并通过客户端测试了这些接口。这种架构可以轻松扩展以支持更多的功能和更复杂的应用场景。希望这篇文章能够帮助你理解如何构建和测试基于REST的Web服务。
欢迎点赞、关注、收藏、转发！！！
