Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs(express.json): clarify usage and add route-specific limit example#2037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
kushal4345 wants to merge8 commits intoexpressjs:gh-pages
base:gh-pages
Choose a base branch
Loading
fromkushal4345:1421-docs-clean

Conversation

@kushal4345
Copy link
Contributor

@kushal4345kushal4345 commentedAug 11, 2025•
edited by ShubhamOulkar
Loading

Summary

This PR updates theexpress.json() documentation to:

  • Clarify behavior and options in a more concise way.
  • Add an example showing how to set differentlimit values for specific routes (e.g.,/upload).

Changes

  • Added a "Different limits for specific routes" section with a code example.
  • Maintained existing style and formatting consistent with the Express docs.
  • Verified that markdown tables and headings render correctly.

Reason

Closes#1421 requests additional clarity on usingexpress.json() with different route limits.
This helps developers quickly understand how to override defaults for specific endpoints without affecting others.

Notes

  • No changes to Express codebase, only to documentation.
  • Follows current contributing and formatting guidelines.

@kushal4345kushal4345 requested a review froma team as acode ownerAugust 11, 2025 05:13
@netlify
Copy link

netlifybot commentedAug 11, 2025•
edited
Loading

✅ Deploy Preview forexpressjscom-preview ready!

NameLink
🔨 Latest commit9d724d6
🔍 Latest deploy loghttps://app.netlify.com/projects/expressjscom-preview/deploys/68bf48622fbd500008552973
😎 Deploy Previewhttps://deploy-preview-2037--expressjscom-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to yourNetlify project configuration.

@github-actions
Copy link
Contributor

github-actionsbot commentedAug 11, 2025•
edited
Loading

🚦 Lighthouse Results (Mobile & Desktop)

URLDevicePerfA11yBest Practices
/mobile🔴 60🟢 100🟠 79
/en/blog/posts.htmlmobile🟠 76🟢 96🟢 96
/en/5x/api.htmlmobile🟠 76🟢 95🟢 96
/desktop🟢 99🟢 100🟠 78
/en/blog/posts.htmldesktop🟢 99🟢 96🟢 93
/en/5x/api.htmldesktop🟢 99🟢 95🟢 96
ShubhamOulkar reacted with thumbs up emoji

Copy link
Member

@ShubhamOulkarShubhamOulkar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I don't think changes are required. Property table explainedlimit option very well and clear. See ouruse middleware page since this example explains how to useexpress.json() middleware.

@kushal4345
Copy link
ContributorAuthor

Thanks for the review!

I understand that the property table explains thelimit option, but I think this example could still add value for developers. The table shows the option in isolation, while this example demonstrates how to apply different limits for specific routes (e.g.,/upload) without affecting the global middleware.

In my experience, beginners often struggle to connect configuration options to real-world route usage, so I felt this would make the docs more practical and beginner-friendly.

Of course, I’m happy to adjust the wording or placement if you think a shorter version would fit better. Please let me know your thoughts!

@ShubhamOulkar
Copy link
Member

@kushal4345, I think updatinguse middleware page would be better. This page includes a built-in middleware section at the bottom.

@kushal4345
Copy link
ContributorAuthor

Thanks for the suggestion

i have Added a new section titled “Different Limits for Specific Routes” to the middleware page.
This section includes a clear code example demonstrating how to set different rate limits for individual routes.
The update aims to make the middleware page more informative and helpful for developers by providing practical usage guidance.

@kushal4345
Copy link
ContributorAuthor

Hi@ShubhamOulkar, I saw you requested changes, but I couldn’t find specific comments in the Files changed tab. Could you clarify what needs to be updated? I’ll make the adjustments accordingly.

Copy link
Member

@bjohansebasbjohansebas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks for your contribution. I agree with@ShubhamOulkar; it makes more sense for this to be under theuse middleware page, not to add it in the API files, because each API describes its functionality and shouldn’t explain how to use it under different forms of middleware.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

From what I can see, you made the change in the wrong file, judging by the commit message.

@kushal4345
Copy link
ContributorAuthor

Hi I’ve updated the using-middleware.md guide to include an example of applying different JSON body size limits for specific routes.

Added a code snippet showing how to set a custom limit (5mb) for /upload.
Ensured the default express.json() still applies for other routes.
Fixed formatting to properly close the markdown code block.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

@kushal4345
Copy link
ContributorAuthor

Thanks for the clarification I’ve added the new example for different limits inside en/guide/using-middleware.md under the Built-in middleware section as suggested. Please let me know if you’d like me to adjust the placement further.

Copy link
Member

@ShubhamOulkarShubhamOulkar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Please remove unnecessary changes


Bind application-level middleware to an instance of the[app object](/{{ page.lang }}/5x/api.html#app) by using the`app.use()` and`app.METHOD()` functions, where`METHOD` is the HTTP method of the request that the middleware function handles (such as GET, PUT, or POST) in lowercase.

This example shows a middleware function with no mount path. The function is executed every time the app receives a request.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

These changes are not required. Please undo it.

-[express.urlencoded](/en/5x/api.html#express.urlencoded) parses incoming requests with URL-encoded payloads.**NOTE: Available with Express 4.16.0+**
gh-pages

Here is an example of using the`express.json` middleware with a custom limit:
Copy link
Member

@ShubhamOulkarShubhamOulkarSep 7, 2025•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

🤔 Should we need separate pages for explaining how to use built in middleware options?
It feels off-topic on the page

Co-authored-by: shubham oulkar <91728992+ShubhamOulkar@users.noreply.github.com>
@jonchurch
Copy link
Member

jonchurch commentedSep 22, 2025•
edited
Loading

The root issueexpressjs/express#3932 that inspired the linked issue is really about understanding middleware ordering and targeting specific routes with specific middleware, not aboutbodyParser.limit setting really.

I don't think the proposed change focused onbodyParser.limit is necessary

@karlhorky
Copy link

karlhorky commentedSep 23, 2025•
edited
Loading

@jonchurch hmm not sure what you mean.

I understoodexpressjs/express#3932 to be about "how can I configure the/upload route with a certain limit and non-/upload routes with a different limit?" since that is the case provided in that issue description at the top of the page.

I think my issue#1421 doesn't subvert that original wish, and that the changes in this PR are helpful for understanding how to achieve this common use case.

Do you disagree with either of those things?

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@bjohansebasbjohansebasbjohansebas requested changes

@ShubhamOulkarShubhamOulkarShubhamOulkar requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document customizingexpress.json() size limit for specific routes

5 participants

@kushal4345@ShubhamOulkar@jonchurch@karlhorky@bjohansebas
[8]ページ先頭
©2009-2025 Movatter.jp