Server

The page contains all information about aiohttp Server API:

• Tutorial
• Quickstart
  • Run a Simple Web Server
  • Command Line Interface (CLI)
  • Handler
  • Resources and Routes
    • Variable Resources
    • Reverse URL Constructing using Named Resources
    • Organizing Handlers in Classes
    • Class Based Views
    • Resource Views
  • Alternative ways for registering routes
  • JSON Response
  • User Sessions
  • HTTP Forms
  • File Uploads
  • WebSockets
  • Redirects
  • Exceptions
• Advanced Usage
  • Unicode support
  • Peer disconnection
  • Passing a coroutine into run_app and Gunicorn
  • Custom Routing Criteria
  • Static file handling
  • Template Rendering
  • Reading from the same task in WebSockets
  • Data Sharing aka No Singletons Please
    • Application’s config
    • Request’s storage
    • Response’s storage
    • Naming hint
  • ContextVars support
  • Middlewares
    • Example
    • Middleware Factory
  • Signals
  • Cleanup Context
  • Nested applications
  • Expect Header
  • Custom resource implementation
  • Application runners
  • Graceful shutdown
  • Background tasks
    • Complex Applications
  • Handling error pages
  • Deploying behind a Proxy
  • Swagger support
  • CORS support
  • Debug Toolbar
  • Dev Tools
• Low Level
  • Abstract
  • Run a Basic Low-Level Server
• Reference
  • Request and Base Request
    • BaseRequest
      • BaseRequest.version
      • BaseRequest.method
      • BaseRequest.url
      • BaseRequest.rel_url
      • BaseRequest.scheme
      • BaseRequest.secure
      • BaseRequest.forwarded
      • BaseRequest.host
      • BaseRequest.remote
      • BaseRequest.path_qs
      • BaseRequest.path
      • BaseRequest.raw_path
      • BaseRequest.query
      • BaseRequest.query_string
      • BaseRequest.headers
      • BaseRequest.raw_headers
      • BaseRequest.keep_alive
      • BaseRequest.transport
      • BaseRequest.loop
      • BaseRequest.cookies
      • BaseRequest.content
      • BaseRequest.body_exists
      • BaseRequest.can_read_body
      • BaseRequest.has_body
      • BaseRequest.content_type
      • BaseRequest.charset
      • BaseRequest.content_length
      • BaseRequest.http_range
      • BaseRequest.if_modified_since
      • BaseRequest.if_unmodified_since
      • BaseRequest.if_match
      • BaseRequest.if_none_match
      • BaseRequest.if_range
      • BaseRequest.clone()
      • BaseRequest.get_extra_info()
    • Request
      • Request.match_info
      • Request.app
      • Request.config_dict
  • Response classes
    • StreamResponse
      • StreamResponse
        • StreamResponse.prepared
        • StreamResponse.task
        • StreamResponse.status
        • StreamResponse.reason
        • StreamResponse.set_status()
        • StreamResponse.keep_alive
        • StreamResponse.force_close()
        • StreamResponse.compression
        • StreamResponse.enable_compression()
        • StreamResponse.chunked
        • StreamResponse.enable_chunked_encoding()
        • StreamResponse.headers
        • StreamResponse.cookies
        • StreamResponse.set_cookie()
        • StreamResponse.del_cookie()
        • StreamResponse.content_length
        • StreamResponse.content_type
        • StreamResponse.charset
        • StreamResponse.last_modified
        • StreamResponse.etag
    • Response
      • Response
        • Response.body
        • Response.text
    • WebSocketResponse
      • WebSocketResponse
        • WebSocketResponse.can_prepare()
        • WebSocketResponse.closed
        • WebSocketResponse.close_code
        • WebSocketResponse.ws_protocol
        • WebSocketResponse.exception()
    • WebSocketReady
      • WebSocketReady
        • WebSocketReady.ok
        • WebSocketReady.protocol
    • json_response
      • json_response()
    • HTTP Exceptions
      • HTTPException
        • HTTPException.status_code
  • Application and Router
    • Application
      • Application
        • Application.router
        • Application.logger
        • Application.loop
        • Application.debug
        • Application.on_response_prepare
        • Application.on_startup
        • Application.on_shutdown
        • Application.on_cleanup
        • Application.cleanup_ctx
        • Application.add_subapp()
        • Application.add_domain()
        • Application.add_routes()
        • Application.make_handler()
    • Server
      • Server
        • Server.connections
        • Server.requests_count
    • Router
      • UrlDispatcher
        • UrlDispatcher.add_resource()
        • UrlDispatcher.add_route()
        • UrlDispatcher.add_routes()
        • UrlDispatcher.add_get()
        • UrlDispatcher.add_post()
        • UrlDispatcher.add_head()
        • UrlDispatcher.add_put()
        • UrlDispatcher.add_patch()
        • UrlDispatcher.add_delete()
        • UrlDispatcher.add_view()
        • UrlDispatcher.add_static()
        • UrlDispatcher.resources()
        • UrlDispatcher.routes()
        • UrlDispatcher.named_resources()
    • Resource
      • AbstractResource
        • AbstractResource.name
        • AbstractResource.canonical
        • AbstractResource.get_info()
        • AbstractResource.url_for()
      • Resource
        • Resource.add_route()
      • PlainResource
        • PlainResource.canonical
        • PlainResource.url_for()
      • DynamicResource
        • DynamicResource.canonical
        • DynamicResource.url_for()
      • StaticResource
        • StaticResource.canonical
        • StaticResource.url_for()
      • PrefixedSubAppResource
        • PrefixedSubAppResource.canonical
        • PrefixedSubAppResource.url_for()
    • Route
      • AbstractRoute
        • AbstractRoute.method
        • AbstractRoute.handler
        • AbstractRoute.name
        • AbstractRoute.resource
        • AbstractRoute.url_for()
      • ResourceRoute
      • SystemRoute
        • SystemRoute.status
        • SystemRoute.reason
    • RouteDef and StaticDef
      • AbstractRouteDef
        • AbstractRouteDef.register()
      • RouteDef
        • RouteDef.method
        • RouteDef.path
        • RouteDef.handler
        • RouteDef.kwargs
      • StaticDef
        • StaticDef.prefix
        • StaticDef.path
        • StaticDef.kwargs
      • get()
      • post()
      • head()
      • put()
      • patch()
      • delete()
      • view()
      • static()
      • route()
    • RouteTableDef
      • RouteTableDef
        • RouteTableDef.get()
        • RouteTableDef.post()
        • RouteTableDef.head()
        • RouteTableDef.put()
        • RouteTableDef.patch()
        • RouteTableDef.delete()
        • RouteTableDef.view()
        • RouteTableDef.static()
        • RouteTableDef.route()
    • MatchInfo
      • UrlMappingMatchInfo
        • UrlMappingMatchInfo.expect_handler
        • UrlMappingMatchInfo.handler
        • UrlMappingMatchInfo.route
    • View
      • View
        • View.request
  • Running Applications
    • BaseRunner
      • BaseRunner.server
      • BaseRunner.addresses
      • BaseRunner.sites
    • AppRunner
      • AppRunner.app
    • ServerRunner
    • BaseSite
      • BaseSite.name
    • TCPSite
    • UnixSite
    • NamedPipeSite
    • SockSite
  • Utilities
    • FileField
      • FileField.name
      • FileField.filename
      • FileField.file
      • FileField.content_type
    • run_app()
  • Constants
    • ContentCoding
      • ContentCoding.deflate
      • ContentCoding.gzip
      • ContentCoding.identity
  • Middlewares
    • Normalize path middleware
      • normalize_path_middleware()
• Logging
  • Access logs
    • Format specification
    • Gunicorn access logs
  • Error logs
• Testing
  • Testing aiohttp web servers
    • Provisional Status
    • The Test Client and Servers
    • Pytest
      • aiohttp_server
      • aiohttp_client
      • aiohttp_raw_server
      • aiohttp_unused_port
    • Unittest
      • AioHTTPTestCase
        • AioHTTPTestCase.client
        • AioHTTPTestCase.server
        • AioHTTPTestCase.loop
        • AioHTTPTestCase.app
        • AioHTTPTestCase.setUp()
        • AioHTTPTestCase.tearDown()
  • Faking request object
    • make_mocked_request()
    • Framework Agnostic Utilities
  • Testing API Reference
    • Test server
      • BaseTestServer
        • BaseTestServer.scheme
        • BaseTestServer.host
        • BaseTestServer.port
        • BaseTestServer.handler
        • BaseTestServer.server
        • BaseTestServer.socket_factory
        • BaseTestServer.make_url()
      • RawTestServer
      • TestServer
        • TestServer.app
    • Test Client
      • TestClient
        • TestClient.scheme
        • TestClient.host
        • TestClient.port
        • TestClient.server
        • TestClient.app
        • TestClient.session
        • TestClient.make_url()
    • Utilities
      • make_mocked_coro()
      • unused_port()
      • loop_context()
      • setup_test_loop()
      • teardown_test_loop()
• Deployment
  • Standalone
  • Nginx+supervisord
    • Nginx configuration
    • Supervisord
    • aiohttp server
  • Nginx+Gunicorn
    • Prepare environment
    • Application
    • Application factory
    • Start Gunicorn
    • Proxy through NGINX
    • Proxy through NGINX + SSL
    • More information
    • Logging configuration
    • Proxy through Apache at your own risk