mirror of
https://github.com/strapi/strapi.git
synced 2025-10-18 19:43:22 +00:00
143 lines
30 KiB
HTML
143 lines
30 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en-US">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<title>Middlewares | Strapi Docs</title>
|
|
<meta name="description" content="API creation made simple, secure and fast.">
|
|
|
|
|
|
<link rel="preload" href="/documentation/assets/css/styles.a8210063.css" as="style"><link rel="preload" href="/documentation/assets/js/app.a8210063.js" as="script"><link rel="preload" href="/documentation/assets/js/32.a6900221.js" as="script"><link rel="prefetch" href="/documentation/assets/js/28.9b077c15.js"><link rel="prefetch" href="/documentation/assets/css/1.styles.77d89b12.css"><link rel="prefetch" href="/documentation/assets/js/1.77d89b12.js"><link rel="prefetch" href="/documentation/assets/css/2.styles.08038ddb.css"><link rel="prefetch" href="/documentation/assets/js/2.08038ddb.js"><link rel="prefetch" href="/documentation/assets/js/3.4d92d5e3.js"><link rel="prefetch" href="/documentation/assets/js/4.385ae6a0.js"><link rel="prefetch" href="/documentation/assets/js/5.edd21cb3.js"><link rel="prefetch" href="/documentation/assets/js/6.fd6e4b24.js"><link rel="prefetch" href="/documentation/assets/js/7.e1f45fa9.js"><link rel="prefetch" href="/documentation/assets/js/8.dc78e1c2.js"><link rel="prefetch" href="/documentation/assets/js/9.fd6a21e6.js"><link rel="prefetch" href="/documentation/assets/js/10.f9e7d997.js"><link rel="prefetch" href="/documentation/assets/js/11.bfb9de0f.js"><link rel="prefetch" href="/documentation/assets/js/12.124227d1.js"><link rel="prefetch" href="/documentation/assets/js/13.d8092700.js"><link rel="prefetch" href="/documentation/assets/js/14.7cfd4cb8.js"><link rel="prefetch" href="/documentation/assets/js/15.55a20f7c.js"><link rel="prefetch" href="/documentation/assets/js/16.5c84c402.js"><link rel="prefetch" href="/documentation/assets/js/17.1c93d494.js"><link rel="prefetch" href="/documentation/assets/js/18.e1f1758f.js"><link rel="prefetch" href="/documentation/assets/js/19.8d1b00cd.js"><link rel="prefetch" href="/documentation/assets/js/20.856d7bdd.js"><link rel="prefetch" href="/documentation/assets/js/21.6f851286.js"><link rel="prefetch" href="/documentation/assets/js/22.7ddb4e1d.js"><link rel="prefetch" href="/documentation/assets/js/23.15e5a0c3.js"><link rel="prefetch" href="/documentation/assets/js/24.6fdf34d0.js"><link rel="prefetch" href="/documentation/assets/js/25.21c9a549.js"><link rel="prefetch" href="/documentation/assets/js/26.6608295c.js"><link rel="prefetch" href="/documentation/assets/js/27.2c9596ea.js"><link rel="prefetch" href="/documentation/assets/js/29.8ea8ecc1.js"><link rel="prefetch" href="/documentation/assets/js/30.5d2829b8.js"><link rel="prefetch" href="/documentation/assets/js/31.fad00a3a.js"><link rel="prefetch" href="/documentation/assets/js/33.bbfb3084.js"><link rel="prefetch" href="/documentation/assets/js/34.0eb2f8aa.js"><link rel="prefetch" href="/documentation/assets/js/35.76c29241.js"><link rel="prefetch" href="/documentation/assets/js/36.dfcc07a1.js"><link rel="prefetch" href="/documentation/assets/js/37.173a8112.js"><link rel="prefetch" href="/documentation/assets/js/38.b86fac79.js"><link rel="prefetch" href="/documentation/assets/js/39.a7d50afe.js"><link rel="prefetch" href="/documentation/assets/js/40.0415492d.js"><link rel="prefetch" href="/documentation/assets/js/41.5ef681df.js"><link rel="prefetch" href="/documentation/assets/js/42.fdd80522.js"><link rel="prefetch" href="/documentation/assets/js/43.03b496f2.js"><link rel="prefetch" href="/documentation/assets/js/44.3f55a367.js"><link rel="prefetch" href="/documentation/assets/js/45.6746c3dc.js"><link rel="prefetch" href="/documentation/assets/js/46.ff6bc353.js"><link rel="prefetch" href="/documentation/assets/js/47.53b7147a.js"><link rel="prefetch" href="/documentation/assets/js/48.31a883aa.js"><link rel="prefetch" href="/documentation/assets/js/49.18bd1a60.js"><link rel="prefetch" href="/documentation/assets/js/50.9b6079cd.js"><link rel="prefetch" href="/documentation/assets/js/51.b67aee1b.js"><link rel="prefetch" href="/documentation/assets/js/52.62bc63b6.js"><link rel="prefetch" href="/documentation/assets/js/53.2c567c55.js"><link rel="prefetch" href="/documentation/assets/js/54.6cc10d25.js"><link rel="prefetch" href="/documentation/assets/js/55.7faca13f.js"><link rel="prefetch" href="/documentation/assets/js/56.0b06ad54.js"><link rel="prefetch" href="/documentation/assets/js/57.a87c48df.js"><link rel="prefetch" href="/documentation/assets/js/58.1c6547d9.js"><link rel="prefetch" href="/documentation/assets/js/59.06f908d7.js"><link rel="prefetch" href="/documentation/assets/js/60.b5156b8d.js"><link rel="prefetch" href="/documentation/assets/js/61.1d5cafa9.js"><link rel="prefetch" href="/documentation/assets/js/62.ccacebe2.js"><link rel="prefetch" href="/documentation/assets/js/63.66946dde.js"><link rel="prefetch" href="/documentation/assets/js/64.d53bdeb7.js"><link rel="prefetch" href="/documentation/assets/js/65.0cd2da1f.js"><link rel="prefetch" href="/documentation/assets/js/66.03059dce.js"><link rel="prefetch" href="/documentation/assets/js/67.6f988923.js"><link rel="prefetch" href="/documentation/assets/js/68.303c1a05.js"><link rel="prefetch" href="/documentation/assets/js/69.3f4ed952.js"><link rel="prefetch" href="/documentation/assets/js/70.531d76be.js"><link rel="prefetch" href="/documentation/assets/js/71.ab3e74fc.js">
|
|
<link rel="stylesheet" href="/documentation/assets/css/styles.a8210063.css"><link rel="stylesheet" href="/documentation/assets/css/1.styles.77d89b12.css"><link rel="stylesheet" href="/documentation/assets/css/2.styles.08038ddb.css">
|
|
</head>
|
|
<body>
|
|
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/documentation/" class="home-link router-link-active"><!----> <span class="site-name">
|
|
Strapi Docs
|
|
</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"> <a href="https://github.com/strapi/strapi" target="_blank" rel="noopener noreferrer" class="repo-link">
|
|
GitHub
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header> <div class="sidebar-mask"></div> <div class="sidebar"><nav class="nav-links"> <a href="https://github.com/strapi/strapi" target="_blank" rel="noopener noreferrer" class="repo-link">
|
|
GitHub
|
|
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav> <div><select class="version-selector"><option value="/3.x.x/" selected="selected">Version 3.x.x</option><option value="/1.x.x/">Version 1.x.x</option></select></div> <ul class="sidebar-links"><li><div class="sidebar-group first"><p class="sidebar-heading"><span>UsefulLinks</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/documentation/3.x.x/" class="sidebar-link">Introduction</a></li><li><a href="https://strapi.io" class="sidebar-link">Strapi Website</a></li><li><a href="https://github.com/strapi/strapi" class="sidebar-link">GitHub Repository</a></li><li><a href="https://github.com/strapi/strapi/blob/master/CONTRIBUTING.md" class="sidebar-link">Contribution Guide</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Getting started</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/documentation/3.x.x/getting-started/installation.html" class="sidebar-link">Installation</a></li><li><a href="/documentation/3.x.x/getting-started/quick-start.html" class="sidebar-link">Quick start</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Globals</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/documentation/3.x.x/api-reference/reference.html" class="sidebar-link">API Reference</a></li><li><a href="/documentation/3.x.x/cli/CLI.html" class="sidebar-link">Command Line Interface (CLI)</a></li><li><a href="/documentation/3.x.x/concepts/concepts.html" class="sidebar-link">Concepts</a></li><li><a href="/documentation/3.x.x/configurations/configurations.html" class="sidebar-link">Configurations</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Guides</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/documentation/3.x.x/guides/authentication.html" class="sidebar-link">Authentication</a></li><li><a href="/documentation/3.x.x/guides/controllers.html" class="sidebar-link">Controllers</a></li><li><a href="/documentation/3.x.x/guides/deployment.html" class="sidebar-link">Deployment</a></li><li><a href="/documentation/3.x.x/guides/email.html" class="sidebar-link">Email</a></li><li><a href="/documentation/3.x.x/guides/filters.html" class="sidebar-link">Filters</a></li><li><a href="/documentation/3.x.x/guides/graphql.html" class="sidebar-link">GraphQL</a></li><li><a href="/documentation/3.x.x/guides/i18n.html" class="sidebar-link">Internationalization</a></li><li><a href="/documentation/3.x.x/guides/models.html" class="sidebar-link">Models</a></li><li><a href="/documentation/3.x.x/guides/policies.html" class="sidebar-link">Policies</a></li><li><a href="/documentation/3.x.x/guides/public-assets.html" class="sidebar-link">Public Assets</a></li><li><a href="/documentation/3.x.x/guides/requests.html" class="sidebar-link">Request</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading open"><span>Advanced</span> <!----></p> <ul class="sidebar-group-items"><li><a href="/documentation/3.x.x/advanced/customize-admin.html" class="sidebar-link">Admin panel</a></li><li><a href="/documentation/3.x.x/advanced/hooks.html" class="sidebar-link">Hooks</a></li><li><a href="/documentation/3.x.x/advanced/logging.html" class="sidebar-link">Logging</a></li><li><a href="/documentation/3.x.x/advanced/middlewares.html" class="active sidebar-link">Middlewares</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/documentation/3.x.x/advanced/middlewares.html#structure" class="sidebar-link">Structure</a></li><li class="sidebar-sub-header"><a href="/documentation/3.x.x/advanced/middlewares.html#custom-middlewares" class="sidebar-link">Custom middlewares</a></li><li class="sidebar-sub-header"><a href="/documentation/3.x.x/advanced/middlewares.html#load-order" class="sidebar-link">Load order</a></li></ul></li><li><a href="/documentation/3.x.x/advanced/usage-tracking.html" class="sidebar-link">Usage tracking</a></li></ul></div></li><li><div class="sidebar-group"><p class="sidebar-heading"><span>Help</span> <!----></p> <ul class="sidebar-group-items"><li><a href="https://github.com/strapi/strapi/wiki" class="sidebar-link">Migration guides</a></li><li><a href="/documentation/3.x.x/tutorials/" class="sidebar-link">Tutorials</a></li></ul></div></li></ul> </div> <div class="page"><div class="content"><h1 id="middlewares"><a href="#middlewares" aria-hidden="true" class="header-anchor">#</a> Middlewares</h1> <p>The middlewares are functions which are composed and executed in a stack-like manner upon request. If you are not familiar with the middleware stack in Koa, we highly recommend you to read the <a href="http://koajs.com/#introduction" target="_blank" rel="noopener noreferrer">Koa's documentation introduction<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>.</p> <p>Enable the middleware in environments settings</p> <p><strong>Path —</strong> [<code>config/environments/**</code>]</p> <div class="language-json extra-class"><pre class="language-json"><code> <span class="token property">"urlReader"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
|
<span class="token property">"enabled"</span><span class="token operator">:</span> <span class="token boolean">true</span>
|
|
<span class="token punctuation">}</span>
|
|
</code></pre></div><p><strong>Path —</strong> <a href="https://github.com/strapi/strapi/blob/master/packages/strapi/lib/middlewares/responseTime/index.js" target="_blank" rel="noopener noreferrer"><code>strapi/lib/middlewares/responseTime/index.js</code><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>.</p> <div class="language-js extra-class"><pre class="language-js"><code>module<span class="token punctuation">.</span><span class="token function-variable function">exports</span> <span class="token operator">=</span> strapi <span class="token operator">=></span> <span class="token punctuation">{</span>
|
|
<span class="token keyword">return</span> <span class="token punctuation">{</span>
|
|
initialize<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>cb<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|
strapi<span class="token punctuation">.</span>app<span class="token punctuation">.</span><span class="token function">use</span><span class="token punctuation">(</span><span class="token keyword">async</span> <span class="token punctuation">(</span>ctx<span class="token punctuation">,</span> next<span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
|
|
<span class="token keyword">const</span> start <span class="token operator">=</span> Date<span class="token punctuation">.</span><span class="token function">now</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
|
|
<span class="token keyword">await</span> <span class="token function">next</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
|
|
<span class="token keyword">const</span> delta <span class="token operator">=</span> Math<span class="token punctuation">.</span><span class="token function">ceil</span><span class="token punctuation">(</span>Date<span class="token punctuation">.</span><span class="token function">now</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">-</span> start<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
|
|
<span class="token comment">// Set X-Response-Time header</span>
|
|
ctx<span class="token punctuation">.</span><span class="token keyword">set</span><span class="token punctuation">(</span><span class="token string">'X-Response-Time'</span><span class="token punctuation">,</span> delta <span class="token operator">+</span> <span class="token string">'ms'</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
|
|
<span class="token function">cb</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">;</span>
|
|
<span class="token punctuation">}</span><span class="token punctuation">;</span>
|
|
</code></pre></div><ul><li><code>initialize</code> (function): Called during the server boot. The callback <code>cb</code> needs to be called. Otherwise, the middleware won't be loaded into the stack.</li></ul> <p>The core of Strapi embraces a small list of middlewares for performances, security and great error handling.</p> <ul><li>boom</li> <li>cors</li> <li>cron</li> <li>csp</li> <li>csrf</li> <li>favicon</li> <li>gzip</li> <li>hsts</li> <li>ip</li> <li>language</li> <li>logger</li> <li>p3p</li> <li>parser</li> <li>public</li> <li>responses</li> <li>responseTime</li> <li>router</li> <li>session</li> <li>xframe</li> <li>xss</li></ul> <div class="note custom-block"><p>The following middlewares cannot be disabled: responses, router, logger and boom.</p></div> <h2 id="structure"><a href="#structure" aria-hidden="true" class="header-anchor">#</a> Structure</h2> <p>A middleware needs to follow the structure below:</p> <div class="language- extra-class"><pre class="language-text"><code>/middleware
|
|
└─── lib
|
|
- index.js
|
|
- LICENSE.md
|
|
- package.json
|
|
- README.md
|
|
</code></pre></div><p>The <code>index.js</code> is the entry point to your middleware. It should look like the example above.</p> <h2 id="custom-middlewares"><a href="#custom-middlewares" aria-hidden="true" class="header-anchor">#</a> Custom middlewares</h2> <p>The framework allows the application to override the default middlewares and add new ones. You have to create a <code>./middlewares</code> folder at the root of your project and put the middlewares into it.</p> <div class="language- extra-class"><pre class="language-text"><code>/project
|
|
└─── admin
|
|
└─── api
|
|
└─── config
|
|
└─── middlewares
|
|
│ └─── responseTime // It will override the core default responseTime middleware
|
|
│ - index.js
|
|
│ └─── views // It will be added into the stack of middleware
|
|
│ - index.js
|
|
└─── plugins
|
|
└─── public
|
|
- favicon.ico
|
|
- package.json
|
|
- server.js
|
|
</code></pre></div><p>Every middleware will be injected into the Koa stack. To manage the load order, please refer to the <a href="#load-order">Middleware order section</a>.</p> <h2 id="load-order"><a href="#load-order" aria-hidden="true" class="header-anchor">#</a> Load order</h2> <p>The middlewares are injected into the Koa stack asynchronously. Sometimes it happens that some of these middlewares need to be loaded in a specific order. To define a load order, we created a dedicated file located in <code>./config/middleware.json</code>.</p> <p><strong>Path —</strong> <code>./config/middleware.json</code>.</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span>
|
|
<span class="token property">"timeout"</span><span class="token operator">:</span> <span class="token number">100</span><span class="token punctuation">,</span>
|
|
<span class="token property">"load"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
|
<span class="token property">"before"</span><span class="token operator">:</span> <span class="token punctuation">[</span>
|
|
<span class="token string">"responseTime"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"logger"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"cors"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"responses"</span>
|
|
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
|
<span class="token property">"order"</span><span class="token operator">:</span> <span class="token punctuation">[</span>
|
|
<span class="token string">"Define the middlewares' load order by putting their name in this array in the right order"</span>
|
|
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
|
<span class="token property">"after"</span><span class="token operator">:</span> <span class="token punctuation">[</span>
|
|
<span class="token string">"parser"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"router"</span>
|
|
<span class="token punctuation">]</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span>
|
|
</code></pre></div><ul><li><code>timeout</code>: defines the maximum allowed milliseconds to load a middleware.</li> <li><code>load</code>:
|
|
<ul><li><code>before</code>: array of middlewares that need to be loaded in the first place. The order of this array matters.</li> <li><code>order</code>: array of middlewares that need to be loaded in a specific order.</li> <li><code>after</code>: array of middlewares that need to be loaded at the end of the stack. The order of this array matters.</li></ul></li></ul> <h4 id="examples"><a href="#examples" aria-hidden="true" class="header-anchor">#</a> Examples</h4> <p><strong>Load a middleware at the very first place</strong></p> <p><strong>Path —</strong> <code>./config/middleware.json</code></p> <div class="language-json extra-class"><pre class="language-json"><code> <span class="token punctuation">{</span>
|
|
<span class="token property">"timeout"</span><span class="token operator">:</span> <span class="token number">100</span><span class="token punctuation">,</span>
|
|
<span class="token property">"load"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
|
<span class="token property">"before"</span><span class="token operator">:</span> <span class="token punctuation">[</span>
|
|
<span class="token string">"responseTime"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"logger"</span>
|
|
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
|
<span class="token property">"order"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
|
|
<span class="token property">"after"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span>
|
|
</code></pre></div><p>The <code>responseTime</code> middleware will be loaded first. Immediately followed by the <code>logger</code> middleware. Then, the others middlewares will be loaded asynchronously.</p> <p><strong>Load a middleware after another one</strong></p> <p><strong>Path —</strong> <code>./config/middleware.json</code>.</p> <div class="language-json extra-class"><pre class="language-json"><code> <span class="token punctuation">{</span>
|
|
<span class="token property">"timeout"</span><span class="token operator">:</span> <span class="token number">100</span><span class="token punctuation">,</span>
|
|
<span class="token property">"load"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
|
<span class="token property">"before"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
|
|
<span class="token property">"order"</span><span class="token operator">:</span> <span class="token punctuation">[</span>
|
|
<span class="token string">"p3p"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"gzip"</span>
|
|
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
|
<span class="token property">"after"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span>
|
|
</code></pre></div><p>The <code>gzip</code> middleware will be loaded after the <code>p3p</code> middleware. All the others will be loaded asynchronously.</p> <p><strong>Load a middleware at the very end</strong></p> <p><strong>Path —</strong> <code>./config/middleware.json</code>.</p> <div class="language-json extra-class"><pre class="language-json"><code> <span class="token punctuation">{</span>
|
|
<span class="token property">"timeout"</span><span class="token operator">:</span> <span class="token number">100</span><span class="token punctuation">,</span>
|
|
<span class="token property">"load"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
|
<span class="token property">"before"</span><span class="token operator">:</span> <span class="token punctuation">[</span>
|
|
...
|
|
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
|
<span class="token property">"order"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span>
|
|
<span class="token property">"after"</span><span class="token operator">:</span> <span class="token punctuation">[</span>
|
|
<span class="token string">"parser"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"router"</span>
|
|
<span class="token punctuation">]</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span>
|
|
</code></pre></div><p>The <code>router</code> middleware will be loaded at the very end. The <code>parser</code> middleware will be loaded after all the others and just before the <code>router</code> middleware.</p> <p><strong>Complete example</strong></p> <p>For this example, we are going to imagine that we have 10 middlewares to load:</p> <ul><li>cors</li> <li>cron</li> <li>favicon</li> <li>gzip</li> <li>logger</li> <li>p3p</li> <li>parser</li> <li>response</li> <li>responseTime</li> <li>router</li></ul> <p>We assume that we set the <code>./config/middleware.json</code> file like this:</p> <div class="language-json extra-class"><pre class="language-json"><code> <span class="token punctuation">{</span>
|
|
<span class="token property">"timeout"</span><span class="token operator">:</span> <span class="token number">100</span><span class="token punctuation">,</span>
|
|
<span class="token property">"load"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
|
|
<span class="token property">"before"</span><span class="token operator">:</span> <span class="token punctuation">[</span>
|
|
<span class="token string">"responseTime"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"logger"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"cors"</span><span class="token punctuation">,</span>
|
|
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
|
<span class="token property">"order"</span><span class="token operator">:</span> <span class="token punctuation">[</span>
|
|
<span class="token string">"p3p"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"gzip"</span>
|
|
<span class="token punctuation">]</span><span class="token punctuation">,</span>
|
|
<span class="token property">"after"</span><span class="token operator">:</span> <span class="token punctuation">[</span>
|
|
<span class="token string">"parser"</span><span class="token punctuation">,</span>
|
|
<span class="token string">"router"</span>
|
|
<span class="token punctuation">]</span>
|
|
<span class="token punctuation">}</span>
|
|
<span class="token punctuation">}</span>
|
|
</code></pre></div><p>Here is the loader order:</p> <ol><li>responseTime (loaded at the very first place)</li> <li>logger</li> <li>cors</li> <li>favicon (position order not guarantee)</li> <li>p3p</li> <li>cron</li> <li>gzip (loaded after the p3p middlewares)</li> <li>response (position order not guarantee)</li> <li>parser</li> <li>router (loaded at the very end place)</li></ol></div> <div class="page-edit"><div class="edit-link"><a href="https://github.com/strapi/strapi/edit/master/docs/3.x.x/advanced/middlewares.md" target="_blank" rel="noopener noreferrer">Improve this page</a> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></div> <!----></div> <div class="page-nav"><p class="inner"><span class="prev">
|
|
← <a href="/documentation/3.x.x/advanced/logging.html" class="prev">
|
|
Logging
|
|
</a></span> <span class="next"><a href="/documentation/3.x.x/advanced/usage-tracking.html">
|
|
Usage tracking
|
|
</a> →
|
|
</span></p></div> </div></div></div>
|
|
<script src="/documentation/assets/js/32.a6900221.js" defer></script><script src="/documentation/assets/js/app.a8210063.js" defer></script>
|
|
</body>
|
|
</html>
|