-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
53 lines (50 loc) · 45 KB
/
index.html
File metadata and controls
53 lines (50 loc) · 45 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Axe API | The fastest way to create Rest API, by defining database models and relations.</title>
<meta name="generator" content="VitePress v1.6.4">
<link rel="preload stylesheet" href="/assets/style.DkhBNZIA.css" as="style">
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
<script type="module" src="/assets/app.DQ0YVGMP.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.DOr3AFF2.js">
<link rel="modulepreload" href="/assets/chunks/framework.z2jLY0sh.js">
<link rel="modulepreload" href="/assets/index.md.DrrZKhCm.lean.js">
<link rel="icon" href="/viking.png">
<meta name="theme-color" content="#3eaf7c">
<meta name="apple-mobile-web-app-capable" content="yes">
<link rel="stylesheet" href="/styles.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/orestbida/cookieconsent@v2.9.1/dist/cookieconsent.css">
<meta name="description" content="Axe API is the next generation rest API framework. You can quickly create a Rest API by simply defining models and relationships.">
<meta name="og:title" content="Axe API">
<meta name="og:description" content="Axe API is the next generation rest API framework. You can quickly create a Rest API by simply defining models and relationships.">
<meta name="image" property="og:image" content="https://axe-api.com/social.png">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Axe API">
<meta name="author" content="Axe API Development Team">
<meta name="twitter:description" content="Axe API is the next generation rest API framework. You can quickly create a Rest API by simply defining models and relationships.">
<meta name="twitter:image" content="https://axe-api.com/social.png">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon" href="/icons/apple-touch-icon-152x152.png">
<link rel="mask-icon" href="/icons/safari-pinned-tab.svg" color="#3eaf7c">
<meta name="msapplication-TileImage" content="/icons/msapplication-icon-144x144.png">
<meta name="msapplication-TileColor" content="#000000">
<script defer src="https://cdn.jsdelivr.net/gh/orestbida/cookieconsent@v2.9.1/dist/cookieconsent.js"></script>
<script defer src="/init.js"></script>
<script defer type="text/plain" src="https://analytics.ozgur.works/script.js" data-cookiecategory="analytics" data-website-id="c15b94fc-d99b-453a-b513-715358f290df"></script>
<script type="text/plain" data-cookiecategory="analytics">
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-1HBM031QWE');
</script>
<script id="check-dark-mode">document.documentElement.classList.add("dark");</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-a4de5d60 data-v-c4daae71><!--[--><!--]--><!--[--><span tabindex="-1" data-v-17ad389b></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-17ad389b>Skip to content</a><!--]--><!----><header class="VPNav" data-v-c4daae71 data-v-a46e73f0><div class="VPNavBar" data-v-a46e73f0 data-v-bb7529ee><div class="wrapper" data-v-bb7529ee><div class="container" data-v-bb7529ee><div class="title" data-v-bb7529ee><div class="VPNavBarTitle" data-v-bb7529ee data-v-5622a072><a class="title" href="/" data-v-5622a072><!--[--><!--]--><!--[--><img class="VPImage logo" src="/viking.png" alt data-v-4d414b82><!--]--><span data-v-5622a072>Axe API</span><!--[--><!--]--></a></div></div><div class="content" data-v-bb7529ee><div class="content-body" data-v-bb7529ee><!--[--><!--]--><div class="VPNavBarSearch search" data-v-bb7529ee><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-bb7529ee data-v-5bacfe89><span id="main-nav-aria-label" class="visually-hidden" data-v-5bacfe89> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/learn/quick-start.html" tabindex="0" data-v-5bacfe89 data-v-8dbce4d0><!--[--><span data-v-8dbce4d0>Learn</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/reference/api-configs.html" tabindex="0" data-v-5bacfe89 data-v-8dbce4d0><!--[--><span data-v-8dbce4d0>API Reference</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/blog/index.html" tabindex="0" data-v-5bacfe89 data-v-8dbce4d0><!--[--><span data-v-8dbce4d0>Blog</span><!--]--></a><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-5bacfe89 data-v-40e55da0><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-40e55da0><span class="text" data-v-40e55da0><!----><span data-v-40e55da0>Upgrading</span><span class="vpi-chevron-down text-icon" data-v-40e55da0></span></span></button><div class="menu" data-v-40e55da0><div class="VPMenu" data-v-40e55da0 data-v-39eca401><div class="items" data-v-39eca401><!--[--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link" href="/upgrading/versioning-policy.html" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>Versioning Policy</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link" href="/upgrading/v1.html" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>v1 (stable)</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link" href="/upgrading/0.30.0.html" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>v0.30</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link" href="/upgrading/0.20.0.html" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>v0.20</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link vp-external-link-icon" href="https://github.com/axe-api/axe-api/releases" target="_blank" rel="noreferrer" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>Releases</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link vp-external-link-icon" href="https://github.com/axe-api/axe-api/blob/master/CHANGELOG.md" target="_blank" rel="noreferrer" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>Changelog</span><!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-5bacfe89 data-v-40e55da0><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-40e55da0><span class="text" data-v-40e55da0><!----><span data-v-40e55da0>Ecosystem</span><span class="vpi-chevron-down text-icon" data-v-40e55da0></span></span></button><div class="menu" data-v-40e55da0><div class="VPMenu" data-v-40e55da0 data-v-39eca401><div class="items" data-v-39eca401><!--[--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link" href="/ecosystem/support.html" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>Support</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link" href="/ecosystem/faq.html" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>FAQ</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link" href="/ecosystem/team.html" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>Team</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link vp-external-link-icon" href="https://github.com/axe-api/axe-magic" target="_blank" rel="noreferrer" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>CLI</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link vp-external-link-icon" href="https://sonarcloud.io/dashboard?id=axe-api_axe-api" target="_blank" rel="noreferrer" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>SonarCloud</span><!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-5bacfe89 data-v-40e55da0><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-40e55da0><span class="text" data-v-40e55da0><!----><span data-v-40e55da0>v1</span><span class="vpi-chevron-down text-icon" data-v-40e55da0></span></span></button><div class="menu" data-v-40e55da0><div class="VPMenu" data-v-40e55da0 data-v-39eca401><div class="items" data-v-39eca401><!--[--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link vp-external-link-icon" href="https://axe-api.com" target="_blank" rel="noreferrer" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>v1 (stable)</span><!--]--></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-39eca401 data-v-65e4a6b1><a class="VPLink link vp-external-link-icon" href="https://legacy.axe-api.com" target="_blank" rel="noreferrer" data-v-65e4a6b1><!--[--><span data-v-65e4a6b1>v0.30</span><!--]--></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://github.com/axe-api/axe-api" target="_blank" rel="noreferrer" tabindex="0" data-v-5bacfe89 data-v-8dbce4d0><!--[--><span data-v-8dbce4d0>GitHub</span><!--]--></a><!--]--><!--]--></nav><!----><!----><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-bb7529ee data-v-08b35e6f data-v-f2234a39><!--[--><a class="VPSocialLink no-icon" href="https://github.com/axe-api/axe-api" aria-label="github" target="_blank" rel="noopener" data-v-f2234a39 data-v-fbf39218><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" href="https://twitter.com/axeapi" aria-label="twitter" target="_blank" rel="noopener" data-v-f2234a39 data-v-fbf39218><span class="vpi-social-twitter"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-bb7529ee data-v-0c845e5d data-v-40e55da0><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-40e55da0><span class="vpi-more-horizontal icon" data-v-40e55da0></span></button><div class="menu" data-v-40e55da0><div class="VPMenu" data-v-40e55da0 data-v-39eca401><!----><!--[--><!--[--><!----><!----><div class="group" data-v-0c845e5d><div class="item social-links" data-v-0c845e5d><div class="VPSocialLinks social-links-list" data-v-0c845e5d data-v-f2234a39><!--[--><a class="VPSocialLink no-icon" href="https://github.com/axe-api/axe-api" aria-label="github" target="_blank" rel="noopener" data-v-f2234a39 data-v-fbf39218><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" href="https://twitter.com/axeapi" aria-label="twitter" target="_blank" rel="noopener" data-v-f2234a39 data-v-fbf39218><span class="vpi-social-twitter"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-bb7529ee data-v-670493dd><span class="container" data-v-670493dd><span class="top" data-v-670493dd></span><span class="middle" data-v-670493dd></span><span class="bottom" data-v-670493dd></span></span></button></div></div></div></div><div class="divider" data-v-bb7529ee><div class="divider-line" data-v-bb7529ee></div></div></div><!----></header><!----><!----><div class="VPContent is-home" id="VPContent" data-v-c4daae71 data-v-d2aef184><div class="VPHome" data-v-d2aef184 data-v-8b59c434><!--[--><!--]--><div class="VPHero VPHomeHero" data-v-8b59c434 data-v-d266baba><div class="container" data-v-d266baba><div class="main" data-v-d266baba><!--[--><!--]--><!--[--><!--[--><!--[--><!--[--><!--[--><div class="container" data-v-a4de5d60><img src="/viking.png" class="viking" data-v-a4de5d60><h2 class="main-brand yellow" data-v-a4de5d60>Axe API</h2><h1 class="text title" data-v-a4de5d60> A <span class="indigo" data-v-a4de5d60>framework</span> to build <span class="indigo" data-v-a4de5d60>Rest API</span></h1><div class="button-container" data-v-a4de5d60><a class="button primary" href="/learn/quick-start" data-v-a4de5d60> Getting started </a><a class="button secondary" href="/reference/api-configs" data-v-a4de5d60> API References </a></div><a href="https://www.producthunt.com/posts/axe-api?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-axe-api" target="_blank" data-v-a4de5d60><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=404818&theme=light" alt="Axe API - The next-generation Rest API framework | Product Hunt" style="width:250px;height:54px;" width="250" height="54" data-v-a4de5d60></a></div><div class="description-section" data-v-a4de5d60><div class="description-box" data-v-a4de5d60> "This is the framework that is missing to build Rest API with best practices. It's build on <span class="important" data-v-a4de5d60>TypeScript</span>. Supports all major RDBMS such as <span class="important" data-v-a4de5d60>PostgreSQL</span>, <span class="important" data-v-a4de5d60>MSSQL</span>, <span class="important" data-v-a4de5d60>MySQL</span>, <span class="important" data-v-a4de5d60>MariaDB</span>, <span class="important" data-v-a4de5d60>Oracle</span> and <span class="important" data-v-a4de5d60>Amazon Redshift</span>." </div></div><div class="box-sections" data-v-a4de5d60><div class="box" data-v-a4de5d60><p data-v-a4de5d60>Frontend developers are going crazy!</p><p data-v-a4de5d60> Many APIs are out there with a lack of documentation and inconsistent design. Yet you can find millions of blog posts discussing the Best Practices of APIs! Backend developers claim they know how to design a high-quality API, but finding a good example is not easy. </p><p data-v-a4de5d60>It is a total mess!</p><p data-v-a4de5d60> Think about how many times you've seen stale API documentation. Nobody has time to maintain it! What about inconsistency in routes? Or, <b data-v-a4de5d60>over-fetching</b> and <b data-v-a4de5d60>under-fetching</b> issues? </p><p class="oversize" data-v-a4de5d60>It should NOT be that hard!</p><p data-v-a4de5d60> Instead, building a Rest API should be easy. We know how to build very well. But the missing part is a framework that is designed to build API. </p><p data-v-a4de5d60>That’s where <span class="brand" data-v-a4de5d60>Axe API</span> comes in.</p></div></div><h2 class="h2" data-v-a4de5d60>Features</h2><!--]--><!--]--><!--]--><!--]--><!--]--><!--[--><!--]--><!----><!--[--><!--]--></div><!----></div></div><!--[--><!--]--><!--[--><!--]--><div class="VPFeatures VPHomeFeatures" data-v-8b59c434 data-v-1da4ff3d><div class="container" data-v-1da4ff3d><div class="items" data-v-1da4ff3d><!--[--><div class="grid-6 item" data-v-1da4ff3d><div class="VPLink no-icon VPFeature" data-v-1da4ff3d data-v-95001937><!--[--><article class="box" data-v-95001937><div class="icon" data-v-95001937>✍</div><h2 class="title" data-v-95001937>Model Definitions</h2><p class="details" data-v-95001937>Define your model, validations, relations, middlewares, etc. in a declarative way to build your API in minutes.</p><!----></article><!--]--></div></div><div class="grid-6 item" data-v-1da4ff3d><div class="VPLink no-icon VPFeature" data-v-1da4ff3d data-v-95001937><!--[--><article class="box" data-v-95001937><div class="icon" data-v-95001937>🛠️</div><h2 class="title" data-v-95001937>Routes Handling</h2><p class="details" data-v-95001937>Axe API will not just create all of your API endpoints automatically. It will also process all of them by your model definition.</p><!----></article><!--]--></div></div><div class="grid-6 item" data-v-1da4ff3d><div class="VPLink no-icon VPFeature" data-v-1da4ff3d data-v-95001937><!--[--><article class="box" data-v-95001937><div class="icon" data-v-95001937>⚓</div><h2 class="title" data-v-95001937>Hooks</h2><p class="details" data-v-95001937>Using hooks is a very elegant technique to add your business logic to your API endpoints in a test-friendly way.</p><!----></article><!--]--></div></div><div class="grid-6 item" data-v-1da4ff3d><div class="VPLink no-icon VPFeature" data-v-1da4ff3d data-v-95001937><!--[--><article class="box" data-v-95001937><div class="icon" data-v-95001937>💡</div><h2 class="title" data-v-95001937>Robust Queries</h2><p class="details" data-v-95001937>Adding robust query features to your API such as sorting, selecting fields, or querying data will cost you nothing.</p><!----></article><!--]--></div></div><div class="grid-6 item" data-v-1da4ff3d><div class="VPLink no-icon VPFeature" data-v-1da4ff3d data-v-95001937><!--[--><article class="box" data-v-95001937><div class="icon" data-v-95001937>⚡️</div><h2 class="title" data-v-95001937>Schema Analyzing</h2><p class="details" data-v-95001937>Axe API analyzes your database schema in the initialization process to compare your models with it.</p><!----></article><!--]--></div></div><div class="grid-6 item" data-v-1da4ff3d><div class="VPLink no-icon VPFeature" data-v-1da4ff3d data-v-95001937><!--[--><article class="box" data-v-95001937><div class="icon" data-v-95001937>📄</div><h2 class="title" data-v-95001937>Auto Documentation</h2><p class="details" data-v-95001937>Axe API creates documentation automatically by checking your model definitions, table relations, database schema, etc.</p><!----></article><!--]--></div></div><!--]--></div></div></div><!--[--><!--]--><div class="vp-doc container" style="" data-v-8b59c434 data-v-2498cc33><!--[--><div style="position:relative;" data-v-8b59c434><div></div></div><!--]--></div></div></div><footer class="VPFooter" data-v-c4daae71 data-v-e3157d6d><div class="container" data-v-e3157d6d><p class="message" data-v-e3157d6d>Released under the MIT License.</p><p class="copyright" data-v-e3157d6d>Copyright © 2020-present</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"404.md\":\"BplurVhx\",\"blog_2021-07-27-a-new-approach-to-create-apis.md\":\"B6jG1LxB\",\"blog_2021-09-21-how-to-create-an-axe-api-from-scratch.md\":\"B7SnKW3R\",\"blog_2023-12-24-axe-api-v1-is-out.md\":\"FTu4yMNT\",\"blog_2024-02-18-axe-api-v1-is-out.md\":\"BKGQcVkM\",\"blog_2024-03-16-axe-api-v1-2-is-out.md\":\"BgQeJZOi\",\"blog_2024-04-08-axe-api-v1-3-is-out.md\":\"ByOBgQZB\",\"blog_2024-04-21-axe-api-v1-4-is-out.md\":\"D20sEqfb\",\"blog_2024-11-19-axe-api-v1-5-is-out.md\":\"BOc2VFJI\",\"blog_2025-01-02-axe-api-v1-6-is-out.md\":\"cE8G4uPD\",\"blog_2025-06-13-axe-api-v1-7-is-out.md\":\"Bo2e33TW\",\"blog_index.md\":\"nOBblNwm\",\"ecosystem_faq.md\":\"EqnIhxnq\",\"ecosystem_support.md\":\"T4ppzy6r\",\"ecosystem_team.md\":\"J2FJ7FeX\",\"errors.md\":\"Tl_CbozR\",\"index.md\":\"DrrZKhCm\",\"learn_application-logic.md\":\"CypnLCc-\",\"learn_authentication.md\":\"CTTtpyIc\",\"learn_bookstore-api.md\":\"3ZFg5JSZ\",\"learn_caching.md\":\"COJ9mJSy\",\"learn_configurations.md\":\"DgtgKQHu\",\"learn_contribution-tests.md\":\"CvORHk_f\",\"learn_contribution.md\":\"C-aSU2sp\",\"learn_database-migrations.md\":\"yP_Zms4r\",\"learn_database-transactions.md\":\"v0uQFL-8\",\"learn_db-analyzer.md\":\"B1-DJPyS\",\"learn_deployment.md\":\"kWdcnt6n\",\"learn_dev-kit-databases.md\":\"Dic6hUh7\",\"learn_development-kit.md\":\"D-qWhcuF\",\"learn_documentation.md\":\"DG7P1y39\",\"learn_error-handling.md\":\"UcKO8WCk\",\"learn_file-uploading.md\":\"Bdp1evbz\",\"learn_full-text-search.md\":\"CxDwPbKK\",\"learn_hooks-and-events.md\":\"Bfhg0yXI\",\"learn_i18n.md\":\"DhcmnMDa\",\"learn_javascript-client-axe-api-client.md\":\"Coy_xSHJ\",\"learn_middlewares.md\":\"BhQFb5C3\",\"learn_models.md\":\"DGybUmXu\",\"learn_querying-data.md\":\"DdnTRubY\",\"learn_quick-start.md\":\"DmGogPnN\",\"learn_rate-limiting.md\":\"DjJY4-aZ\",\"learn_related-data-queries.md\":\"2hT5poEQ\",\"learn_request-response-cycle.md\":\"D7cfKZzU\",\"learn_routing.md\":\"DId_Xj9u\",\"learn_serializers.md\":\"BvdaTyn7\",\"learn_serving-static-files.md\":\"DOF6y3fe\",\"learn_testing.md\":\"BRBouQPy\",\"learn_validations.md\":\"CNG1Hrq_\",\"learn_version-management.md\":\"B8G2fWI9\",\"privacy-policy.md\":\"c5DJ8DQ6\",\"reference_api-configs.md\":\"BPaA9MIW\",\"reference_api-error.md\":\"CoY7JfJA\",\"reference_app.md\":\"XOewJH2g\",\"reference_axe-request.md\":\"CS_LX0ab\",\"reference_axe-response.md\":\"38D-2w3y\",\"reference_cache-configs.md\":\"CitBnpne\",\"reference_client-add-request.md\":\"ByEueSup\",\"reference_client-add-response.md\":\"DZn1JdV4\",\"reference_client-and-where.md\":\"AgK8d9W7\",\"reference_client-delete.md\":\"CTYJM_l2\",\"reference_client-first.md\":\"DYLpY1Ie\",\"reference_client-insert.md\":\"BF-Vv3jf\",\"reference_client-or-where.md\":\"C0MlNnCM\",\"reference_client-paginate.md\":\"CNu0vffb\",\"reference_client-patch.md\":\"CjRnC9PZ\",\"reference_client-resource.md\":\"6kLGS5f-\",\"reference_client-set-config.md\":\"DyDeKgEV\",\"reference_client-update.md\":\"lJCnKvMq\",\"reference_client-where-between.md\":\"BWqWVSTw\",\"reference_client-where-in.md\":\"CWoffdCL\",\"reference_client-where-like.md\":\"Dcqlbpad\",\"reference_client-where-null.md\":\"BjlL5Dxi\",\"reference_client-where.md\":\"Bxe-9I1z\",\"reference_client-with.md\":\"CdX55F6I\",\"reference_database-configs.md\":\"vCiquxc4\",\"reference_default-handlers.md\":\"9FIW70J-\",\"reference_elastic-search-configs.md\":\"DRYY4Xe_\",\"reference_error-codes.md\":\"BJIHg5tS\",\"reference_handlers-all-handler.md\":\"BpwPN5c-\",\"reference_handlers-delete-handler.md\":\"DtwszdMD\",\"reference_handlers-force-delete-handler.md\":\"hmKtsLo0\",\"reference_handlers-insert-handler.md\":\"TO7AoAWP\",\"reference_handlers-paginate-handler.md\":\"CEcLtZFz\",\"reference_handlers-patch-handler.md\":\"CozuTLp4\",\"reference_handlers-search-handler.md\":\"DxigLYJY\",\"reference_handlers-show-handler.md\":\"BKfZHy-B\",\"reference_handlers-update-handler.md\":\"CxmvWVfk\",\"reference_hooks-events-on-after-all.md\":\"BDxo9p9R\",\"reference_hooks-events-on-after-delete-query.md\":\"D5wckXOd\",\"reference_hooks-events-on-after-delete.md\":\"BU1Mb0v4\",\"reference_hooks-events-on-after-force-delete-query.md\":\"DfVKP8OW\",\"reference_hooks-events-on-after-force-delete.md\":\"DyNkZ5TI\",\"reference_hooks-events-on-after-insert.md\":\"LvmKDj2O\",\"reference_hooks-events-on-after-paginate.md\":\"B78k5F3Q\",\"reference_hooks-events-on-after-patch-query.md\":\"DF-8N6Cz\",\"reference_hooks-events-on-after-patch.md\":\"DK7EQ_rK\",\"reference_hooks-events-on-after-search.md\":\"8RBs-3WA\",\"reference_hooks-events-on-after-show.md\":\"DOuyRYaB\",\"reference_hooks-events-on-after-update-query.md\":\"Df6-8q6T\",\"reference_hooks-events-on-after-update.md\":\"BmRv3jt5\",\"reference_hooks-events-on-before-all.md\":\"fl_E_Gi7\",\"reference_hooks-events-on-before-delete-query.md\":\"BB7mnwXL\",\"reference_hooks-events-on-before-delete.md\":\"DiI533ZF\",\"reference_hooks-events-on-before-force-delete-query.md\":\"CQsq1zxa\",\"reference_hooks-events-on-before-force-delete.md\":\"BMNJu-kx\",\"reference_hooks-events-on-before-insert.md\":\"DPCKOh6M\",\"reference_hooks-events-on-before-paginate.md\":\"8YnbSyGA\",\"reference_hooks-events-on-before-patch-query.md\":\"BdCTjEcg\",\"reference_hooks-events-on-before-patch.md\":\"C2uh-TvA\",\"reference_hooks-events-on-before-search.md\":\"3VLqRr5i\",\"reference_hooks-events-on-before-show.md\":\"D7fUBX68\",\"reference_hooks-events-on-before-update-query.md\":\"8yW0qHIR\",\"reference_hooks-events-on-before-update.md\":\"6_zfpRAJ\",\"reference_icontext.md\":\"DI54ANPw\",\"reference_ioc.md\":\"ILAIz5H_\",\"reference_model-cache.md\":\"CmqI5BYj\",\"reference_model-created-at-column.md\":\"Dig-jT6X\",\"reference_model-deleted-at-column.md\":\"CDs92KoQ\",\"reference_model-fillable.md\":\"er3wpBn0\",\"reference_model-get-search-query.md\":\"BQosaXs4\",\"reference_model-handlers.md\":\"DnWEBwAJ\",\"reference_model-hiddens.md\":\"CiltnlKK\",\"reference_model-ignore.md\":\"BxdiSSK_\",\"reference_model-limits.md\":\"DCQ6P3ok\",\"reference_model-middlewares.md\":\"DtnMrvDb\",\"reference_model-primary-key.md\":\"rnmcxS3p\",\"reference_model-search.md\":\"DgKMLKA7\",\"reference_model-table.md\":\"BCSl6s3q\",\"reference_model-transactions.md\":\"BxFEC0A8\",\"reference_model-updated-at-column.md\":\"HPMhdnYv\",\"reference_model-validations.md\":\"CmWXSmrX\",\"reference_on-after-init.md\":\"B2yuFM0V\",\"reference_on-before-init.md\":\"73ULKx2K\",\"reference_pino-logger-configs.md\":\"DgPG9zCl\",\"reference_queries-fields.md\":\"DSNFmfI_\",\"reference_queries-page.md\":\"DwvdXlPH\",\"reference_queries-per-page.md\":\"DWm3VAqb\",\"reference_queries-q.md\":\"BeSwnVEH\",\"reference_queries-sort.md\":\"baAfPbHR\",\"reference_queries-trashed.md\":\"BxFfUrnY\",\"reference_queries-with.md\":\"C0YQU8hl\",\"reference_rate-limit-configs.md\":\"BMf5oHgr\",\"reference_redis-configs.md\":\"HiutyAxi\",\"reference_search-configs.md\":\"dR1lkCMi\",\"reference_version-configs.md\":\"BokV3FLX\",\"rest-api.md\":\"BdmCUUkw\",\"upgrading_0.20.0.md\":\"-OoVzyMr\",\"upgrading_0.30.0.md\":\"CsDzlNdf\",\"upgrading_v1.md\":\"DX6EpY6c\",\"upgrading_versioning-policy.md\":\"BQcqp1hu\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Axe API\",\"description\":\"The fastest way to create Rest API, by defining database models and relations.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":\"force-dark\",\"themeConfig\":{\"logo\":\"/viking.png\",\"editLink\":{\"pattern\":\"https://github.com/axe-api/docs/edit/master/docs/:path\",\"text\":\"Edit this page on GitHub\"},\"nav\":[{\"text\":\"Learn\",\"link\":\"/learn/quick-start\"},{\"text\":\"API Reference\",\"link\":\"/reference/api-configs\"},{\"text\":\"Blog\",\"link\":\"/blog/index\"},{\"text\":\"Upgrading\",\"items\":[{\"text\":\"Versioning Policy\",\"link\":\"/upgrading/versioning-policy\"},{\"text\":\"v1 (stable)\",\"link\":\"/upgrading/v1\"},{\"text\":\"v0.30\",\"link\":\"/upgrading/0.30.0.html\"},{\"text\":\"v0.20\",\"link\":\"/upgrading/0.20.0.html\"},{\"text\":\"Releases\",\"link\":\"https://github.com/axe-api/axe-api/releases\"},{\"text\":\"Changelog\",\"link\":\"https://github.com/axe-api/axe-api/blob/master/CHANGELOG.md\"}]},{\"text\":\"Ecosystem\",\"items\":[{\"text\":\"Support\",\"link\":\"/ecosystem/support\"},{\"text\":\"FAQ\",\"link\":\"/ecosystem/faq\"},{\"text\":\"Team\",\"link\":\"/ecosystem/team\"},{\"text\":\"CLI\",\"link\":\"https://github.com/axe-api/axe-magic\"},{\"text\":\"SonarCloud\",\"link\":\"https://sonarcloud.io/dashboard?id=axe-api_axe-api\"}]},{\"text\":\"v1\",\"items\":[{\"text\":\"v1 (stable)\",\"link\":\"https://axe-api.com\"},{\"text\":\"v0.30\",\"link\":\"https://legacy.axe-api.com\"}]},{\"text\":\"GitHub\",\"link\":\"https://github.com/axe-api/axe-api\"}],\"sidebar\":{\"/learn/\":[{\"text\":\"Getting Started\",\"collapsed\":false,\"items\":[{\"text\":\"Quick start\",\"link\":\"/learn/quick-start\"},{\"text\":\"Tutorial: Bookstore API\",\"link\":\"/learn/bookstore-api\"}]},{\"text\":\"Fundamentals\",\"collapsed\":true,\"items\":[{\"text\":\"What does a Model mean?\",\"link\":\"/learn/models\"},{\"text\":\"Understanding the routing\",\"link\":\"/learn/routing\"},{\"text\":\"Version management\",\"link\":\"/learn/version-management\"},{\"text\":\"Validate your data\",\"link\":\"/learn/validations\"}]},{\"text\":\"Gains\",\"collapsed\":true,\"items\":[{\"text\":\"Auto-created documentation\",\"link\":\"/learn/documentation\"},{\"text\":\"Querying data\",\"link\":\"/learn/querying-data\"},{\"text\":\"Related data queries\",\"link\":\"/learn/related-data-queries\"},{\"text\":\"Auto-caching\",\"link\":\"/learn/caching\"},{\"text\":\"Full-text search\",\"link\":\"/learn/full-text-search\"},{\"text\":\"JavaScript Client\",\"link\":\"/learn/javascript-client-axe-api-client\"},{\"text\":\"How DB Analyzer works?\",\"link\":\"/learn/db-analyzer\"}]},{\"text\":\"Application Logic\",\"collapsed\":true,\"items\":[{\"text\":\"Getting started\",\"link\":\"/learn/application-logic\"},{\"text\":\"Request-Response cycle\",\"link\":\"/learn/request-response-cycle\"},{\"text\":\"Middlewares\",\"link\":\"/learn/middlewares\"},{\"text\":\"Hooks & Events\",\"link\":\"/learn/hooks-and-events\"},{\"text\":\"Serializers\",\"link\":\"/learn/serializers\"}]},{\"text\":\"Advanced\",\"collapsed\":true,\"items\":[{\"text\":\"Configurations\",\"link\":\"/learn/configurations\"},{\"text\":\"Internationalization\",\"link\":\"/learn/i18n\"},{\"text\":\"Error handling\",\"link\":\"/learn/error-handling\"},{\"text\":\"Database transactions\",\"link\":\"/learn/database-transactions\"}]},{\"text\":\"How to?\",\"collapsed\":true,\"items\":[{\"text\":\"Migrate database\",\"link\":\"/learn/database-migrations\"},{\"text\":\"File uploading\",\"link\":\"/learn/file-uploading\"},{\"text\":\"Serving static files\",\"link\":\"/learn/serving-static-files\"},{\"text\":\"Authentication\",\"link\":\"/learn/authentication\"},{\"text\":\"Rate limiting\",\"link\":\"/learn/rate-limiting\"},{\"text\":\"Testing\",\"link\":\"/learn/testing\"},{\"text\":\"Deployment\",\"link\":\"/learn/deployment\"}]},{\"text\":\"Contribution\",\"collapsed\":true,\"items\":[{\"text\":\"Preparation\",\"link\":\"/learn/contribution\"},{\"text\":\"Development Kit\",\"link\":\"/learn/development-kit\"},{\"text\":\"Databases\",\"link\":\"/learn/dev-kit-databases\"},{\"text\":\"Tests\",\"link\":\"/learn/contribution-tests\"}]}],\"/reference/\":[{\"text\":\"Configs\",\"collapsed\":false,\"items\":[{\"text\":\"API configs\",\"link\":\"/reference/api-configs\"},{\"text\":\"Pino (logger) configs\",\"link\":\"/reference/pino-logger-configs\"},{\"text\":\"Rate limit configs\",\"link\":\"/reference/rate-limit-configs\"},{\"text\":\"Database configs\",\"link\":\"/reference/database-configs\"},{\"text\":\"Cache configs\",\"link\":\"/reference/cache-configs\"},{\"text\":\"Redis configs\",\"link\":\"/reference/redis-configs\"},{\"text\":\"Elasticsearch configs\",\"link\":\"/reference/elastic-search-configs\"},{\"text\":\"Search configs\",\"link\":\"/reference/search-configs\"},{\"text\":\"Version configs\",\"link\":\"/reference/version-configs\"}]},{\"text\":\"Initialization\",\"collapsed\":true,\"items\":[{\"text\":\"onBeforeInit()\",\"link\":\"/reference/on-before-init\"},{\"text\":\"onAfterInit()\",\"link\":\"/reference/on-after-init\"}]},{\"text\":\"Axe API\",\"collapsed\":true,\"items\":[{\"text\":\"App\",\"link\":\"/reference/app\"},{\"text\":\"IContext\",\"link\":\"/reference/icontext\"},{\"text\":\"AxeRequest\",\"link\":\"/reference/axe-request\"},{\"text\":\"AxeResponse\",\"link\":\"/reference/axe-response\"},{\"text\":\"IoC\",\"link\":\"/reference/ioc\"},{\"text\":\"ApiError\",\"link\":\"/reference/api-error\"},{\"text\":\"Error Codes\",\"link\":\"/errors\"}]},{\"text\":\"Models\",\"collapsed\":true,\"items\":[{\"text\":\"table()\",\"link\":\"/reference/model-table\"},{\"text\":\"primaryKey()\",\"link\":\"/reference/model-primary-key\"},{\"text\":\"fillable()\",\"link\":\"/reference/model-fillable\"},{\"text\":\"validations()\",\"link\":\"/reference/model-validations\"},{\"text\":\"hiddens()\",\"link\":\"/reference/model-hiddens\"},{\"text\":\"createdAtColumn()\",\"link\":\"/reference/model-created-at-column\"},{\"text\":\"updatedAtColumn()\",\"link\":\"/reference/model-updated-at-column\"},{\"text\":\"deletedAtColumn()\",\"link\":\"/reference/model-deleted-at-column\"},{\"text\":\"handlers()\",\"link\":\"/reference/model-handlers\"},{\"text\":\"middlewares()\",\"link\":\"/reference/model-middlewares\"},{\"text\":\"transactions()\",\"link\":\"/reference/model-transactions\"},{\"text\":\"limits()\",\"link\":\"/reference/model-limits\"},{\"text\":\"cache()\",\"link\":\"/reference/model-cache\"},{\"text\":\"search()\",\"link\":\"/reference/model-search\"},{\"text\":\"getSearchQuery()\",\"link\":\"/reference/model-get-search-query\"},{\"text\":\"ignore()\",\"link\":\"/reference/model-ignore\"}]},{\"text\":\"Handlers\",\"collapsed\":true,\"items\":[{\"text\":\"Defaults\",\"link\":\"/reference/default-handlers\"},{\"text\":\"INSERT\",\"link\":\"/reference/handlers-insert-handler\"},{\"text\":\"PAGINATE\",\"link\":\"/reference/handlers-paginate-handler\"},{\"text\":\"SHOW\",\"link\":\"/reference/handlers-show-handler\"},{\"text\":\"UPDATE\",\"link\":\"/reference/handlers-update-handler\"},{\"text\":\"DELETE\",\"link\":\"/reference/handlers-delete-handler\"},{\"text\":\"FORCE_DELETE\",\"link\":\"/reference/handlers-force-delete-handler\"},{\"text\":\"PATCH\",\"link\":\"/reference/handlers-patch-handler\"},{\"text\":\"ALL\",\"link\":\"/reference/handlers-all-handler\"},{\"text\":\"SEARCH\",\"link\":\"/reference/handlers-search-handler\"}]},{\"text\":\"Queries\",\"collapsed\":true,\"items\":[{\"text\":\"fields\",\"link\":\"/reference/queries-fields\"},{\"text\":\"sort\",\"link\":\"/reference/queries-sort\"},{\"text\":\"page\",\"link\":\"/reference/queries-page\"},{\"text\":\"per_page\",\"link\":\"/reference/queries-per-page\"},{\"text\":\"trashed\",\"link\":\"/reference/queries-trashed\"},{\"text\":\"q\",\"link\":\"/reference/queries-q\"},{\"text\":\"with\",\"link\":\"/reference/queries-with\"}]},{\"text\":\"Hooks & Events\",\"collapsed\":true,\"items\":[{\"text\":\"onBeforeInsert()\",\"link\":\"/reference/hooks-events-on-before-insert\"},{\"text\":\"onBeforeUpdateQuery()\",\"link\":\"/reference/hooks-events-on-before-update-query\"},{\"text\":\"onBeforeUpdate()\",\"link\":\"/reference/hooks-events-on-before-update\"},{\"text\":\"onBeforePatchQuery()\",\"link\":\"/reference/hooks-events-on-before-patch-query\"},{\"text\":\"onBeforePatch()\",\"link\":\"/reference/hooks-events-on-before-patch\"},{\"text\":\"onBeforeDeleteQuery()\",\"link\":\"/reference/hooks-events-on-before-delete-query\"},{\"text\":\"onBeforeDelete()\",\"link\":\"/reference/hooks-events-on-before-delete\"},{\"text\":\"onBeforeForceDeleteQuery()\",\"link\":\"/reference/hooks-events-on-before-force-delete-query\"},{\"text\":\"onBeforeForceDelete()\",\"link\":\"/reference/hooks-events-on-before-force-delete\"},{\"text\":\"onBeforePaginate()\",\"link\":\"/reference/hooks-events-on-before-paginate\"},{\"text\":\"onBeforeAll()\",\"link\":\"/reference/hooks-events-on-before-all\"},{\"text\":\"onBeforeSearch()\",\"link\":\"/reference/hooks-events-on-before-search\"},{\"text\":\"onBeforeShow()\",\"link\":\"/reference/hooks-events-on-before-show\"},{\"text\":\"onAfterInsert()\",\"link\":\"/reference/hooks-events-on-after-insert\"},{\"text\":\"onAfterUpdateQuery()\",\"link\":\"/reference/hooks-events-on-after-update-query\"},{\"text\":\"onAfterUpdate()\",\"link\":\"/reference/hooks-events-on-after-update\"},{\"text\":\"onAfterPatchQuery()\",\"link\":\"/reference/hooks-events-on-after-patch-query\"},{\"text\":\"onAfterPatch()\",\"link\":\"/reference/hooks-events-on-after-patch\"},{\"text\":\"onAfterDeleteQuery()\",\"link\":\"/reference/hooks-events-on-after-delete-query\"},{\"text\":\"onAfterDelete()\",\"link\":\"/reference/hooks-events-on-after-delete\"},{\"text\":\"onAfterForceDeleteQuery()\",\"link\":\"/reference/hooks-events-on-after-force-delete-query\"},{\"text\":\"onAfterForceDelete()\",\"link\":\"/reference/hooks-events-on-after-force-delete\"},{\"text\":\"onAfterPaginate()\",\"link\":\"/reference/hooks-events-on-after-paginate\"},{\"text\":\"onAfterAll()\",\"link\":\"/reference/hooks-events-on-after-all\"},{\"text\":\"onAfterSearch()\",\"link\":\"/reference/hooks-events-on-after-search\"},{\"text\":\"onAfterShow()\",\"link\":\"/reference/hooks-events-on-after-show\"}]},{\"text\":\"Axe API Client\",\"collapsed\":true,\"items\":[{\"text\":\"setConfig()\",\"link\":\"/reference/client-set-config\"},{\"text\":\"addRequest()\",\"link\":\"/reference/client-add-request\"},{\"text\":\"addResponse()\",\"link\":\"/reference/client-add-response\"},{\"text\":\"first()\",\"link\":\"/reference/client-first\"},{\"text\":\"resource()\",\"link\":\"/reference/client-resource\"},{\"text\":\"insert()\",\"link\":\"/reference/client-insert\"},{\"text\":\"update()\",\"link\":\"/reference/client-update\"},{\"text\":\"patch()\",\"link\":\"/reference/client-patch\"},{\"text\":\"delete()\",\"link\":\"/reference/client-delete\"},{\"text\":\"paginate()\",\"link\":\"/reference/client-paginate\"},{\"text\":\"with()\",\"link\":\"/reference/client-with\"},{\"text\":\"where()\",\"link\":\"/reference/client-where\"},{\"text\":\"orWhere()\",\"link\":\"/reference/client-or-where\"},{\"text\":\"andWhere()\",\"link\":\"/reference/client-and-where\"},{\"text\":\"whereLike()\",\"link\":\"/reference/client-where-like\"},{\"text\":\"whereIn()\",\"link\":\"/reference/client-where-in\"},{\"text\":\"whereBetween()\",\"link\":\"/reference/client-where-between\"},{\"text\":\"whereNull()\",\"link\":\"/reference/client-where-null\"}]}],\"/errors\":[{\"text\":\"Configs\",\"collapsed\":false,\"items\":[{\"text\":\"API configs\",\"link\":\"/reference/api-configs\"},{\"text\":\"Pino (logger) configs\",\"link\":\"/reference/pino-logger-configs\"},{\"text\":\"Rate limit configs\",\"link\":\"/reference/rate-limit-configs\"},{\"text\":\"Database configs\",\"link\":\"/reference/database-configs\"},{\"text\":\"Cache configs\",\"link\":\"/reference/cache-configs\"},{\"text\":\"Redis configs\",\"link\":\"/reference/redis-configs\"},{\"text\":\"Elasticsearch configs\",\"link\":\"/reference/elastic-search-configs\"},{\"text\":\"Search configs\",\"link\":\"/reference/search-configs\"},{\"text\":\"Version configs\",\"link\":\"/reference/version-configs\"}]},{\"text\":\"Initialization\",\"collapsed\":true,\"items\":[{\"text\":\"onBeforeInit()\",\"link\":\"/reference/on-before-init\"},{\"text\":\"onAfterInit()\",\"link\":\"/reference/on-after-init\"}]},{\"text\":\"Axe API\",\"collapsed\":true,\"items\":[{\"text\":\"App\",\"link\":\"/reference/app\"},{\"text\":\"IContext\",\"link\":\"/reference/icontext\"},{\"text\":\"AxeRequest\",\"link\":\"/reference/axe-request\"},{\"text\":\"AxeResponse\",\"link\":\"/reference/axe-response\"},{\"text\":\"IoC\",\"link\":\"/reference/ioc\"},{\"text\":\"ApiError\",\"link\":\"/reference/api-error\"},{\"text\":\"Error Codes\",\"link\":\"/errors\"}]},{\"text\":\"Models\",\"collapsed\":true,\"items\":[{\"text\":\"table()\",\"link\":\"/reference/model-table\"},{\"text\":\"primaryKey()\",\"link\":\"/reference/model-primary-key\"},{\"text\":\"fillable()\",\"link\":\"/reference/model-fillable\"},{\"text\":\"validations()\",\"link\":\"/reference/model-validations\"},{\"text\":\"hiddens()\",\"link\":\"/reference/model-hiddens\"},{\"text\":\"createdAtColumn()\",\"link\":\"/reference/model-created-at-column\"},{\"text\":\"updatedAtColumn()\",\"link\":\"/reference/model-updated-at-column\"},{\"text\":\"deletedAtColumn()\",\"link\":\"/reference/model-deleted-at-column\"},{\"text\":\"handlers()\",\"link\":\"/reference/model-handlers\"},{\"text\":\"middlewares()\",\"link\":\"/reference/model-middlewares\"},{\"text\":\"transactions()\",\"link\":\"/reference/model-transactions\"},{\"text\":\"limits()\",\"link\":\"/reference/model-limits\"},{\"text\":\"cache()\",\"link\":\"/reference/model-cache\"},{\"text\":\"search()\",\"link\":\"/reference/model-search\"},{\"text\":\"getSearchQuery()\",\"link\":\"/reference/model-get-search-query\"},{\"text\":\"ignore()\",\"link\":\"/reference/model-ignore\"}]},{\"text\":\"Handlers\",\"collapsed\":true,\"items\":[{\"text\":\"Defaults\",\"link\":\"/reference/default-handlers\"},{\"text\":\"INSERT\",\"link\":\"/reference/handlers-insert-handler\"},{\"text\":\"PAGINATE\",\"link\":\"/reference/handlers-paginate-handler\"},{\"text\":\"SHOW\",\"link\":\"/reference/handlers-show-handler\"},{\"text\":\"UPDATE\",\"link\":\"/reference/handlers-update-handler\"},{\"text\":\"DELETE\",\"link\":\"/reference/handlers-delete-handler\"},{\"text\":\"FORCE_DELETE\",\"link\":\"/reference/handlers-force-delete-handler\"},{\"text\":\"PATCH\",\"link\":\"/reference/handlers-patch-handler\"},{\"text\":\"ALL\",\"link\":\"/reference/handlers-all-handler\"},{\"text\":\"SEARCH\",\"link\":\"/reference/handlers-search-handler\"}]},{\"text\":\"Queries\",\"collapsed\":true,\"items\":[{\"text\":\"fields\",\"link\":\"/reference/queries-fields\"},{\"text\":\"sort\",\"link\":\"/reference/queries-sort\"},{\"text\":\"page\",\"link\":\"/reference/queries-page\"},{\"text\":\"per_page\",\"link\":\"/reference/queries-per-page\"},{\"text\":\"trashed\",\"link\":\"/reference/queries-trashed\"},{\"text\":\"q\",\"link\":\"/reference/queries-q\"},{\"text\":\"with\",\"link\":\"/reference/queries-with\"}]},{\"text\":\"Hooks & Events\",\"collapsed\":true,\"items\":[{\"text\":\"onBeforeInsert()\",\"link\":\"/reference/hooks-events-on-before-insert\"},{\"text\":\"onBeforeUpdateQuery()\",\"link\":\"/reference/hooks-events-on-before-update-query\"},{\"text\":\"onBeforeUpdate()\",\"link\":\"/reference/hooks-events-on-before-update\"},{\"text\":\"onBeforePatchQuery()\",\"link\":\"/reference/hooks-events-on-before-patch-query\"},{\"text\":\"onBeforePatch()\",\"link\":\"/reference/hooks-events-on-before-patch\"},{\"text\":\"onBeforeDeleteQuery()\",\"link\":\"/reference/hooks-events-on-before-delete-query\"},{\"text\":\"onBeforeDelete()\",\"link\":\"/reference/hooks-events-on-before-delete\"},{\"text\":\"onBeforeForceDeleteQuery()\",\"link\":\"/reference/hooks-events-on-before-force-delete-query\"},{\"text\":\"onBeforeForceDelete()\",\"link\":\"/reference/hooks-events-on-before-force-delete\"},{\"text\":\"onBeforePaginate()\",\"link\":\"/reference/hooks-events-on-before-paginate\"},{\"text\":\"onBeforeAll()\",\"link\":\"/reference/hooks-events-on-before-all\"},{\"text\":\"onBeforeSearch()\",\"link\":\"/reference/hooks-events-on-before-search\"},{\"text\":\"onBeforeShow()\",\"link\":\"/reference/hooks-events-on-before-show\"},{\"text\":\"onAfterInsert()\",\"link\":\"/reference/hooks-events-on-after-insert\"},{\"text\":\"onAfterUpdateQuery()\",\"link\":\"/reference/hooks-events-on-after-update-query\"},{\"text\":\"onAfterUpdate()\",\"link\":\"/reference/hooks-events-on-after-update\"},{\"text\":\"onAfterPatchQuery()\",\"link\":\"/reference/hooks-events-on-after-patch-query\"},{\"text\":\"onAfterPatch()\",\"link\":\"/reference/hooks-events-on-after-patch\"},{\"text\":\"onAfterDeleteQuery()\",\"link\":\"/reference/hooks-events-on-after-delete-query\"},{\"text\":\"onAfterDelete()\",\"link\":\"/reference/hooks-events-on-after-delete\"},{\"text\":\"onAfterForceDeleteQuery()\",\"link\":\"/reference/hooks-events-on-after-force-delete-query\"},{\"text\":\"onAfterForceDelete()\",\"link\":\"/reference/hooks-events-on-after-force-delete\"},{\"text\":\"onAfterPaginate()\",\"link\":\"/reference/hooks-events-on-after-paginate\"},{\"text\":\"onAfterAll()\",\"link\":\"/reference/hooks-events-on-after-all\"},{\"text\":\"onAfterSearch()\",\"link\":\"/reference/hooks-events-on-after-search\"},{\"text\":\"onAfterShow()\",\"link\":\"/reference/hooks-events-on-after-show\"}]},{\"text\":\"Axe API Client\",\"collapsed\":true,\"items\":[{\"text\":\"setConfig()\",\"link\":\"/reference/client-set-config\"},{\"text\":\"addRequest()\",\"link\":\"/reference/client-add-request\"},{\"text\":\"addResponse()\",\"link\":\"/reference/client-add-response\"},{\"text\":\"first()\",\"link\":\"/reference/client-first\"},{\"text\":\"resource()\",\"link\":\"/reference/client-resource\"},{\"text\":\"insert()\",\"link\":\"/reference/client-insert\"},{\"text\":\"update()\",\"link\":\"/reference/client-update\"},{\"text\":\"patch()\",\"link\":\"/reference/client-patch\"},{\"text\":\"delete()\",\"link\":\"/reference/client-delete\"},{\"text\":\"paginate()\",\"link\":\"/reference/client-paginate\"},{\"text\":\"with()\",\"link\":\"/reference/client-with\"},{\"text\":\"where()\",\"link\":\"/reference/client-where\"},{\"text\":\"orWhere()\",\"link\":\"/reference/client-or-where\"},{\"text\":\"andWhere()\",\"link\":\"/reference/client-and-where\"},{\"text\":\"whereLike()\",\"link\":\"/reference/client-where-like\"},{\"text\":\"whereIn()\",\"link\":\"/reference/client-where-in\"},{\"text\":\"whereBetween()\",\"link\":\"/reference/client-where-between\"},{\"text\":\"whereNull()\",\"link\":\"/reference/client-where-null\"}]}],\"/upgrading/\":[{\"text\":\"Versioning Policy\",\"link\":\"/upgrading/versioning-policy\"},{\"text\":\"Upgrading to v1\",\"link\":\"/upgrading/v1\"},{\"text\":\"Upgrading to 0.30.0\",\"link\":\"/upgrading/0.30.0.html\"},{\"text\":\"Upgrading to 0.20.0\",\"link\":\"/upgrading/0.20.0.html\"}],\"/ecosystem/\":[{\"text\":\"Support\",\"link\":\"/ecosystem/support\"},{\"text\":\"FAQ\",\"link\":\"/ecosystem/faq\"},{\"text\":\"Team\",\"link\":\"/ecosystem/team\"},{\"text\":\"CLI\",\"link\":\"https://github.com/axe-api/axe-magic\"},{\"text\":\"SonarCloud\",\"link\":\"https://sonarcloud.io/dashboard?id=axe-api_axe-api\"}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/axe-api/axe-api\"},{\"icon\":\"twitter\",\"link\":\"https://twitter.com/axeapi\"}],\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2020-present\"},\"search\":{\"provider\":\"local\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
</body>
</html>