mirror of
https://github.com/strapi/strapi.git
synced 2025-08-19 06:08:50 +00:00
92 lines
36 KiB
HTML
92 lines
36 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html lang="en-US">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|||
|
|
<title>Quick start | 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/39.a7d50afe.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/32.a6900221.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/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="/docum
|
|||
|
|
<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 open"><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="active sidebar-link">Quick start</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/documentation/3.x.x/getting-started/quick-start.html#create-your-first-project" class="sidebar-link">Create your first project</a></li><li class="sidebar-sub-header"><a href="/documentation/3.x.x/getting-started/quick-start.html#create-your-first-user" class="sidebar-link">Create your first user</a></li><li class="sidebar-sub-header"><a href="/documentation/3.x.x/getting-started/quick-start.html#create-your-first-api" class="sidebar-link">Create your first API</a></li><li class="sidebar-sub-header"><a href="/documentation/3.x.x/getting-started/quick-start.html#manage-your-data" class="sidebar-link">Manage your data</a></li><li class="sidebar-sub-header"><a href="/documentation/3.x.x/getting-started/quick-start.html#consume-your-api" class="sidebar-link">Consume your API</a></li></ul></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
|
|||
|
|
</code></pre></div><p><img src="/documentation/assets/img/terminal_new.3f7e23c3.png" alt="Generate a Strapi project"></p> <p>This action creates a new folder named <code>my-project</code> with the entire <a href="/documentation/3.x.x/concepts/concepts.html#files-structure">files structure</a> of a Strapi application.</p> <p><strong>#3 — Go to your project and launch the server:</strong></p> <p>In your terminal run the following commands:</p> <div class="language-bash extra-class"><pre class="language-bash"><code><span class="token function">cd</span> my-project
|
|||
|
|
strapi start
|
|||
|
|
</code></pre></div><p><img src="/documentation/assets/img/terminal_start.b3a7364f.png" alt="Start Strapi"></p> <p>Now that your app is running let's see how to <a href="#create-your-first-user">create your first user</a>.</p> <hr> <h2 id="create-your-first-user"><a href="#create-your-first-user" aria-hidden="true" class="header-anchor">#</a> Create your first user</h2> <p>In order to use the admin panel and to consume your API you first need to register your first user. This process only happens once if you don't have any user table created and is made to create the <code>admin user</code> that has all the permissions granted for your API.</p> <p>If your using MongoDB for your database you don't have to create your table manually (it's already handled by Strapi) otherwise you'll have to create your user table first.</p> <p>To create your first user, start your server (<code>strapi start</code>) and go to : http://localhost:1337/admin.</p> <p><img src="/documentation/assets/img/getting-started_register.e656c1ff.png" alt="Register View"></p> <p>Now that your first user is registered let's see how to <a href="#create-your-first-api">create your first api</a>.</p> <hr> <h2 id="create-your-first-api"><a href="#create-your-first-api" aria-hidden="true" class="header-anchor">#</a> Create your first API</h2> <p>To create your first API, start your server (<code>strapi start</code>) and go to : http://localhost:1337/admin.</p> <p>At this point, your application is empty. To create your first API is to use the <strong>Content Type Builder</strong> plugin: a powerful UI to help you create an API in a few clicks. Let's take the example of an e-commerce API, which manages products.</p> <p><strong>#1 —</strong> Go to the <strong>Content Type Builder</strong> plugin.</p> <p><img src="/documentation/assets/img/getting-started_no_content_type.144f7dab.png" alt="Content Type Builder - Home"></p> <p><strong>#2 —</strong> Create a Content Type named <code>Product</code> and submit the form.</p> <p><img src="/documentation/assets/img/getting-started_create_content_type.f4e658ac.png" alt="Content Type Builder - Create a new Content Type"></p> <p><strong>#3 —</strong> Add three fields in this Content Type.</p> <ul><li>A <code>string</code> field named <code>name</code>.</li> <li>A <code>text</code> field named <code>description</code>.</li> <li>A <code>number</code> field named <code>price</code> (with <code>float</code> as number format).</li></ul> <p><img src="/documentation/assets/img/getting-started_list_fields.ecdf11cf.png" alt="Content Type Builder - List fields in Product"></p> <p><strong>#4 —</strong> Save. That's it!</p> <div class="note custom-block"><p>See the <a href="/documentation/3.x.x/cli/CLI.html#strapi-generateapi">CLI documentation</a> for more information on how to do it the hacker way.</p></div> <h3 id="files-structure"><a href="#files-structure" aria-hidden="true" class="header-anchor">#</a> Files structure</h3> <p>A new directory has been created in the <code>./api</code> folder of your application which contains all the needed stuff for your <code>Product</code> Content Type: routes, controllers, services and models. Take a look at the <a href="/documentation/3.x.x/concepts/concepts.html#files-structure">API structure documentation</a> for more informations.</p> <p><strong>Well done, you created your first API using Strapi!</strong></p> <hr> <h2 id="manage-your-data"><a href="#manage-your-data" aria-hidden="true" class="header-anchor">#</a> Manage your data</h2> <p>After creating <a href="#create-your-first-api">your first Content Type</a>, it would be great to be able to create, edit or delete entries.</p> <p><strong>#1 —</strong> Go to the <a href="http://localhost:1337/admin/plugins/content-manager/product/" target="_blank" rel="noopener noreferrer"><strong>Product list</strong><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-32
|
|||
|
|
In order to do so, you'll need to allow access to other users (identified as 'Guest').</p> <p><strong>1 -</strong> Go to the <a href="http://localhost:1337/admin/plugins/users-permissions/roles" target="_blank" rel="noopener noreferrer"><strong>Auth & Permissions View</strong><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> by clicking on <strong>Auth & Permissions</strong> link in the left menu and click on the <strong>Guest Role</strong> item.</p> <p><img src="/documentation/assets/img/getting-started_manage_role_home.11fb8455.png" alt="Auth & Permissions - Home"></p> <p><strong>2 -</strong> Manage your APIs permissions in the <strong>Permissions</strong> section of the <a href="http://localhost:1337/admin/plugins/users-permissions/roles/edit/1" target="_blank" rel="noopener noreferrer"><strong>Edit Guest Role view</strong><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> by enabling or disabling specific actions.</p> <p><img src="/documentation/assets/img/getting-started_allow_access.ea852994.png" alt="Auth & Permissions - Edit Guest"></p> <h3 id="list-entries-get"><a href="#list-entries-get" aria-hidden="true" class="header-anchor">#</a> List entries (GET)</h3> <p>To retrieve the list of products, use the <code>GET /your-content-type</code> route.</p> <p>Generated APIs provide a handy way to filter and order queries. In that way, ordering products by price is as easy as <code>GET http://localhost:1337/product?_sort=price:asc</code>. For more informations, read the <a href="/documentation/3.x.x/guides/filters.html">filters documentation</a></p> <p>Here is an example using jQuery.</p> <div class="language-js extra-class"><pre class="language-js"><code>$<span class="token punctuation">.</span><span class="token function">ajax</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
|
|||
|
|
type<span class="token punctuation">:</span> <span class="token string">'GET'</span><span class="token punctuation">,</span>
|
|||
|
|
url<span class="token punctuation">:</span> <span class="token string">'http://localhost:1337/product?_sort=price:asc'</span><span class="token punctuation">,</span> <span class="token comment">// Order by price.</span>
|
|||
|
|
done<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>products<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'Well done, here is the list of products: '</span><span class="token punctuation">,</span> products<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|||
|
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
|||
|
|
fail<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>error<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'An error occurred:'</span><span class="token punctuation">,</span> error<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><h3 id="get-a-specific-entry-get"><a href="#get-a-specific-entry-get" aria-hidden="true" class="header-anchor">#</a> Get a specific entry (GET)</h3> <p>If you want to get a specific entry, add the <code>id</code> of the wanted product at the end of the url.</p> <div class="language-js extra-class"><pre class="language-js"><code>$<span class="token punctuation">.</span><span class="token function">ajax</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
|
|||
|
|
type<span class="token punctuation">:</span> <span class="token string">'GET'</span><span class="token punctuation">,</span>
|
|||
|
|
url<span class="token punctuation">:</span> <span class="token string">'http://localhost:1337/product/123'</span><span class="token punctuation">,</span> <span class="token comment">// Where `123` is the `id` of the product.</span>
|
|||
|
|
done<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>product<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'Well done, here is the product having the `id` 123: '</span><span class="token punctuation">,</span> product<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|||
|
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
|||
|
|
fail<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>error<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'An error occurred:'</span><span class="token punctuation">,</span> error<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><h3 id="create-data-post"><a href="#create-data-post" aria-hidden="true" class="header-anchor">#</a> Create data (POST)</h3> <p>Use the <code>POST</code> route to create a new entry.</p> <p>jQuery example:</p> <div class="language-js extra-class"><pre class="language-js"><code>$<span class="token punctuation">.</span><span class="token function">ajax</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
|
|||
|
|
type<span class="token punctuation">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span>
|
|||
|
|
url<span class="token punctuation">:</span> <span class="token string">'http://localhost:1337/product'</span><span class="token punctuation">,</span>
|
|||
|
|
data<span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
|||
|
|
name<span class="token punctuation">:</span> <span class="token string">'Cheese cake'</span><span class="token punctuation">,</span>
|
|||
|
|
description<span class="token punctuation">:</span> <span class="token string">'Chocolate cheese cake with ice cream'</span><span class="token punctuation">,</span>
|
|||
|
|
price<span class="token punctuation">:</span> <span class="token number">5</span>
|
|||
|
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
|||
|
|
done<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>product<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'Congrats, your product has been successfully created: '</span><span class="token punctuation">,</span> product<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// Remember the product `id` for the next steps.</span>
|
|||
|
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
|||
|
|
fail<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>error<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'An error occurred:'</span><span class="token punctuation">,</span> error<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><h3 id="update-data-put"><a href="#update-data-put" aria-hidden="true" class="header-anchor">#</a> Update data (PUT)</h3> <p>Use the <code>PUT</code> route to update an existing entry.</p> <p>jQuery example:</p> <div class="language-js extra-class"><pre class="language-js"><code>$<span class="token punctuation">.</span><span class="token function">ajax</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
|
|||
|
|
type<span class="token punctuation">:</span> <span class="token string">'PUT'</span><span class="token punctuation">,</span>
|
|||
|
|
url<span class="token punctuation">:</span> <span class="token string">'http://localhost:1337/product/123'</span><span class="token punctuation">,</span> <span class="token comment">// Where `123` is the `id` of the product.</span>
|
|||
|
|
data<span class="token punctuation">:</span> <span class="token punctuation">{</span>
|
|||
|
|
description<span class="token punctuation">:</span> <span class="token string">'This is the new description'</span>
|
|||
|
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
|||
|
|
done<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>product<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'Congrats, your product has been successfully updated: '</span><span class="token punctuation">,</span> product<span class="token punctuation">.</span>description<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|||
|
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
|||
|
|
fail<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>error<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'An error occurred:'</span><span class="token punctuation">,</span> error<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><h3 id="delete-data-delete"><a href="#delete-data-delete" aria-hidden="true" class="header-anchor">#</a> Delete data (DELETE)</h3> <p>Use the <code>DELETE</code> route to delete an existing entry.</p> <p>jQuery example:</p> <div class="language-js extra-class"><pre class="language-js"><code>$<span class="token punctuation">.</span><span class="token function">ajax</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
|
|||
|
|
type<span class="token punctuation">:</span> <span class="token string">'DELETE'</span><span class="token punctuation">,</span>
|
|||
|
|
url<span class="token punctuation">:</span> <span class="token string">'http://localhost:1337/product/123'</span><span class="token punctuation">,</span> <span class="token comment">// Where `123` is the `id` of the product.</span>
|
|||
|
|
done<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>product<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'Congrats, your product has been successfully deleted: '</span><span class="token punctuation">,</span> product<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
|||
|
|
<span class="token punctuation">}</span><span class="token punctuation">,</span>
|
|||
|
|
fail<span class="token punctuation">:</span> <span class="token keyword">function</span><span class="token punctuation">(</span>error<span class="token punctuation">)</span> <span class="token punctuation">{</span>
|
|||
|
|
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span><span class="token string">'An error occurred:'</span><span class="token punctuation">,</span> error<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><hr> <p>Congratulations! You successfully finished the Getting Started guide! Read the <a href="/documentation/3.x.x/concepts/concepts.html">concepts</a> to understand more advanced concepts.</p> <p>Also, feel free to join the community thanks to the different channels listed in the <a href="http://strapi.io/community" target="_blank" rel="noopener noreferrer">community page<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>: team members, contributors and developers will be happy to help you.</p></div> <div class="page-edit"><div class="edit-link"><a href="https://github.com/strapi/strapi/edit/master/docs/3.x.x/getting-started/quick-start.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/getting-started/installation.html" class="prev">
|
|||
|
|
Installation
|
|||
|
|
</a></span> <span class="next"><a href="/documentation/3.x.x/api-reference/reference.html">
|
|||
|
|
API Reference
|
|||
|
|
</a> →
|
|||
|
|
</span></p></div> </div></div></div>
|
|||
|
|
<script src="/documentation/assets/js/39.a7d50afe.js" defer></script><script src="/documentation/assets/js/app.a8210063.js" defer></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|