Эндпоинты

Starlette включает HTTPEndpoint и WebSocketEndpoint Классы, которые обеспечивают режим представления на основе классов для обработки планирования методов HTTP и сеансов WebSocket.

HTTP-конечные точки

HTTPEndpoint Класс может использоваться в качестве приложения ASGI:

from starlette.responses import PlainTextResponse
from Starlette.endpoints import HTTPENDpoint


Class App(HTTPENDpoint):
    async def get(self, request):
        return PlainTextResponse(f"Hello, world!")

Если вы используете экземпляр приложения Starlette для обработки маршрутизации, вы можете отправить его в класс HTTPEndpoint. Убедитесь, что вы отправляете его на сам класс, а не на экземпляр класса:

from Starlette.applications import Starlette
from starlette.responses import PlainTextResponse
from Starlette.endpoints import HTTPENDpoint
От Starlet.routing Import Route


Class Homepage(HTTPENDpoint):
    async def get(self, request):
        return PlainTextResponse(f"Hello, world!")


class User(HTTPENDpoint)
    async def get(self, request):
        username = request.path_params ['username']
        return PlainTextResponse(f"Hello,{username}")

routes = [
    Route("/", Homepage),
    Route("/{username}", User)
]

app = Starlette(routes=routes)

Для любого метода запроса, который не был сопоставлен с соответствующим обработчиком, класс конечных точек HTTP будет отвечать «Метод 405 не разрешен».

Конечная точка WebSocket

Класс WebSocketEndpoint-это приложение ASGI, которое предоставляет упаковочный пакет вокруг функциональности экземпляра WebSocket.

Диапазон соединений ASGI доступен через .scope в экземпляре конечной точки и имеет свойство encoding, которое можно настроить для проверки ожидаемых данных WebSocket в методе on_receive.

Типы кодирования:

• 'json'
• 'bytes'
• 'text'

Существует три способа перезаписи для обработки определенных типов сообщений ASGI WebSocket:

• async def on_connect(websocket, **kwargs)
• async def on_receive(websocket, data)

• async def on_disconnect(websocket, close_code)

  from Starlett.endpoints import WebSocketEndpoint

  Class App(WebSocketEndpoint): Encoding = 'bytes'

  async def on_connect (self, websocket):
      websocket.accept(
  
  async def on_receive (self, websocket, data):
      websocket.send_bytes (b"Message: " + data)
  
  async def on_disconnect (self, websocket, close_code):
      Pass
  

WebSocketEndpoint также можно использовать с классами приложений Starlette:

Import UVicorn
from Starlette.applications import Starlette
from starlett.endpoints import WebSocketEndpoint, HTTPENDpoint
from starlette.responses import HTMLResponse
from starlette routing import Route, WebSocketRoute


html = "
<!DOCTYPE html>
<html>
    <head>
        <title>Chat</title>
    </head>
    <body>
        <h1>WebSocket Chat</h1>
        <form action="" onsubmit="sendMessage(event)">
            <input type="text" id="messageText" autocomplete="off"/>
            <button>Send</button>
        </form>
        <ul id='messages'>
        </ul>
        <script>
            var ws = new WebSocket("ws://localhost:8000/ws");
            WS.onmessage = function(event)
                var messages = document.getElementById ('messages')
                var message = document.createElement ('li')
                var content = document.createTextNode (event.data)
                message.appendChild(content)
                Messages.appendChild(message)
            };
            function sendMessage(event)
                var input = document.getElementById ("messageText")
                ws.send (input value)
                input.value = '
                event.preventDefault()
            }
        </script>
    </body>
</html>
"""

Class Homepage(HTTPENDpoint):
    async def get(self, request):
        Return HTMLResponse(html)

Класс Echo(WebSocketEndpoint):
    encoding = "text"

    async def on_receive (self, websocket, data):
        websocket.send_text (f"Message text was:{data}")

routes =]
    Route("/", Homepage),
    WebSocketRoute('/ws', Echo)
]

app = Starlette(routes=routes)