add_middleware is missing from the documentation

[sandeep-gh]

Not sure if this is intentional, but add_middleware member function of Starlette() is used quite a few places but is missing from the documentation. Especially on the middleware page (https://www.starlette.io/middleware/). Probably a omission and needs fixing.

[adriangb]

This is intentional:

starlette/starlette/applications.py

Line 126 in 182ed74

# The following usages are now discouraged in favour of configuration

Where are you seeing it mentioned?

[sandeep-gh]

I see. Not sure exactly where I picked it up from. But the authentication page https://www.starlette.io/authentication/ very last line mentions add_middleware
app.add_middleware(AuthenticationMiddleware, backend=BasicAuthBackend(), on_error=on_auth_error)

[adriangb]

Good catch! We removed that line now

[Kludex]

For reference, the documentation will have those changes when Starlette 0.21.0 is released.

[WolfgangFahl]

Downstream at justpy we'll have to do the changes and I don't understand what is expected:
The comment:
#The following usages are now discouraged in favour of configuration
seems to expect that some code that is in use today such as:

app.add_middleware(GZipMiddleware)
if SSL_KEYFILE and SSL_CERTFILE:
    app.add_middleware(HTTPSRedirectMiddleware)

should be modified. But how - what is the new expected way of achieving the same functionality?

[adriangb]

Something like:

middleware = [Middleware(GZipMiddleware)]
if SSL_KEYFILE and SSL_CERTFILE:
    middleware.append(Middleware(HTTPSRedirectMiddleware)
app = Starlette(..., middleware=middleware)