docs: update Middleware API reference#30485
Merged
kodiakhq[bot] merged 1 commit intovercel:canaryfrom Oct 27, 2021
Merged
Conversation
styfle
approved these changes
Oct 27, 2021
Contributor
Both are acceptable return values. The NextResponse object has some helper methods on it. We should definitely have examples linked from the Middleware docs to here: https://github.com/vercel/examples |
Contributor
Author
|
Turns out Middleware is already kind of supported by import { getToken } from "next-auth/jwt"
import { NextResponse } from "next/server"
export async function middleware(req) {
// return early if url isn't supposed to be protected
if (!req.url.includes("/protected-url")) {
return NextResponse.next()
}
const session = await getToken({ req, secret: process.env.SECRET })
// You could also check for any property on the session object,
// like rolec === "admin" or name === "John Doe", etc.
if (!session) return NextResponse.redirect("/api/auth/signin")
// If user is authenticated, continue.
return NextResponse.next()
}What I would like is if we had a nicer API for this, and we also got the Database Session working. Again, I am not sure of the bottleneck effect there, since we have to do multiple database queries. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I changed the order of
NextRequestandNextFetchEventas they are presented in the function signature.There also seemed to be some issues with the heading levels.
Also,
NextResponseis a documented API, but the example code usesResponse. I wasn't sure if this was a mistake in the docs or in the code.I noticed that other similar docs pages have a collapsible
Examplessection at their top:Image below:
Should the Middleware docs have the same?