摘要：入門指南路由路由允許用戶為不同的端點指定處理程序函數。被訪問服務器的基本，最終被路由器匹配到處理程序函數，測試，然后返回一個對象。請求參數將作為關鍵字參數傳遞給路線處理程序函數。例如所有有效的參數必須傳遞給以便構建一個。

Install Sanic：python3 -m pip install sanic
example

from sanic import Sanic
from sanic.response import text
app = Sanic(__name__)
@app.route("/")
async def test(request):
    return text("Hello world!")
app.run(host="0.0.0.0", port=8000, debug=True)

路由允許用戶為不同的URL端點指定處理程序函數。

demo:

from sanic.response import json
@app.route("/")
async def test(request):
    return json({ "hello": "world" })

url http://server.url/ 被訪問(服務器的基本url)，最終"/"被路由器匹配到處理程序函數，測試，然后返回一個JSON對象。

要指定一個參數，可以用像這樣的角引號包圍它。請求參數將作為關鍵字參數傳遞給路線處理程序函數。
demo

from sanic.response import text
@app.route("/tag/")
async def tag_handler(request, tag):
    return text("Tag - {}".format(tag))

為參數指定類型，在參數名后面添加（：類型）。如果參數不匹配指定的類型，Sanic將拋出一個不存在的異常，導致一個404頁面
demo：

from sanic.response import text
@app.route("/number/")
async def integer_handler(request, integer_arg):
    return text("Integer - {}".format(integer_arg))
@app.route("/number/")
async def number_handler(request, number_arg):
    return text("Number - {}".format(number_arg))
@app.route("/person/")
async def person_handler(request, name):
    return text("Person - {}".format(name))
@app.route("/folder/")
async def folder_handler(request, folder_id):
    return text("Folder - {}".format(folder_id))

路由裝飾器接受一個可選的參數，方法，它允許處理程序函數與列表中的任何HTTP方法一起工作。
demo_1
from sanic.response import text
@app.route("/post", methods=["POST"])
async def post_handler(request):
    return text("POST request - {}".format(request.json))
@app.route("/get", methods=["GET"])
async def get_handler(request):
    return text("GET request - {}".format(request.args))
demo_2
from sanic.response import text
@app.post("/post")
async def post_handler(request):
    return text("POST request - {}".format(request.json))
@app.get("/get")
async def get_handler(request):
    return text("GET request - {}".format(request.args))

from sanic.response import text
# Define the handler functions
async def handler1(request):
    return text("OK")
async def handler2(request, name):
    return text("Folder - {}".format(name))
async def person_handler2(request, name):
    return text("Person - {}".format(name))
# Add each handler function as a route
app.add_route(handler1, "/test")
app.add_route(handler2, "/folder/")
app.add_route(person_handler2, "/person/", methods=["GET"])

Sanic提供了一個urlfor方法，根據處理程序方法名生成url。避免硬編碼url路徑到您的應用程序
demo

@app.route("/")
async def index(request):
    # generate a URL for the endpoint `post_handler`
    url = app.url_for("post_handler", post_id=5)
    # the URL is `/posts/5`, redirect to it
    return redirect(url)
@app.route("/posts/")
async def post_handler(request, post_id):
    return text("Post - {}".format(post_id))

Notice:

給url equest的關鍵字參數不是請求參數，它將包含在URL的查詢字符串中。例如:

url = app.url_for("post_handler", post_id=5, arg_one="one", arg_two="two")
# /posts/5?arg_one=one&arg_two=two

所有有效的參數必須傳遞給url以便構建一個URL。如果沒有提供一個參數，或者一個參數與指定的類型不匹配，就會拋出一個URLBuildError
可以將多值參數傳遞給url

url = app.url_for("post_handler", post_id=5, arg_one=["one", "two"])
# /posts/5?arg_one=one&arg_one=two

websocket 可以通過裝飾路由實現
demo：

@app.websocket("/feed")
async def feed(request, ws):
    while True:
        data = "hello!"
        print("Sending: " + data)
        await ws.send(data)
        data = await ws.recv()
        print("Received: " + data)
        
另外，添加 websocket 路由方法可以代替裝飾器

async def feed(request, ws):
    pass
app.add_websocket_route(my_websocket_handler, "/feed")

from sanic import response
@app.route("/text")
def handle_request(request):
    return response.text("Hello world!")

from sanic import response
@app.route("/html")
def handle_request(request):
    return response.html("
Hello world!
")

from sanic import response
@app.route("/json")
def handle_request(request):
    return response.json({"message": "Hello world!"})

from sanic import response
@app.route("/file")
async def handle_request(request):
    return await response.file("/srv/www/whatever.png")

from sanic import response
@app.route("/streaming")
async def index(request):
    async def streaming_fn(response):
        response.write("foo")
        response.write("bar")
    return response.stream(streaming_fn, content_type="text/plain")

對于大文件，文件和流的組合

from sanic import response
@app.route("/big_file.png")
async def handle_request(request):
    return await response.file_stream("/srv/www/whatever.png")

from sanic import response
@app.route("/redirect")
def handle_request(request):
    return response.redirect("/json")

沒有進行編碼的響應

from sanic import response
@app.route(‘/raw ’)
def handle_request(request):
return response.raw(‘ raw data ’)

要修改頭或狀態代碼，將標題或狀態參數傳遞給這些函數

from sanic import response
@app.route(‘/json ’)
def handle_request(request):
return response.json(
{‘ message ’: ‘ Hello world!’},
headers={‘ X-Served-By ’: ‘ sanic ’},
status=200
)

更多的內容:Sanic 中文文檔

靜態文件

異常處理

中間件和監聽

藍圖

配置

裝飾器

流

請求數據

試圖類