mirror of
https://github.com/strapi/strapi.git
synced 2025-07-24 17:40:18 +00:00
275 lines
4.9 KiB
Markdown
275 lines
4.9 KiB
Markdown
# Services
|
||
|
||
## Concept
|
||
|
||
Services are a set of reusable functions. They are particularly useful to respect the DRY (don’t repeat yourself) programming concept and to simplify [controllers](./controllers.md) logic.
|
||
|
||
## Core services
|
||
|
||
When you create a new Content type or a new model. You will see a new empty service has been created. It is because Strapi builds a generic service for your models by default and allows you to override and extend it in the generated files.
|
||
|
||
### Extending a Model Service
|
||
|
||
Here are the core methods (and their current implementation).
|
||
You can simply copy and paste this code to your own service file to customize the methods.
|
||
|
||
You can read about `strapi.query` calls [here](./queries.md)
|
||
|
||
::: tip
|
||
In the following example your controller, service and model is named `restaurant`
|
||
:::
|
||
|
||
:::: tabs
|
||
|
||
::: tab find
|
||
|
||
#### `find`
|
||
|
||
```js
|
||
module.exports = {
|
||
/**
|
||
* Promise to fetch all records
|
||
*
|
||
* @return {Promise}
|
||
*/
|
||
find(params, populate) {
|
||
return strapi.query('restaurant').find(params, populate);
|
||
},
|
||
};
|
||
```
|
||
|
||
:::
|
||
|
||
::: tab findOne
|
||
|
||
#### `findOne`
|
||
|
||
```js
|
||
module.exports = {
|
||
/**
|
||
* Promise to fetch record
|
||
*
|
||
* @return {Promise}
|
||
*/
|
||
|
||
findOne(params, populate) {
|
||
return strapi.query('restaurant').findOne(params, populate);
|
||
},
|
||
};
|
||
```
|
||
|
||
:::
|
||
|
||
::: tab count
|
||
|
||
#### `count`
|
||
|
||
```js
|
||
module.exports = {
|
||
/**
|
||
* Promise to count record
|
||
*
|
||
* @return {Promise}
|
||
*/
|
||
|
||
count(params) {
|
||
return strapi.query('restaurant').count(params);
|
||
},
|
||
};
|
||
```
|
||
|
||
:::
|
||
|
||
::: tab create
|
||
|
||
#### `create`
|
||
|
||
```js
|
||
module.exports = {
|
||
/**
|
||
* Promise to add record
|
||
*
|
||
* @return {Promise}
|
||
*/
|
||
|
||
async create(data, { files } = {}) {
|
||
const entry = await strapi.query(model).create(data);
|
||
|
||
if (files) {
|
||
// automatically uploads the files based on the entry and the model
|
||
await this.uploadFiles(entry, files, { model: strapi.models.restaurant });
|
||
return this.findOne({ id: entry.id });
|
||
}
|
||
|
||
return entry;
|
||
},
|
||
};
|
||
```
|
||
|
||
:::
|
||
|
||
::: tab update
|
||
|
||
#### `update`
|
||
|
||
```js
|
||
module.exports = {
|
||
/**
|
||
* Promise to edit record
|
||
*
|
||
* @return {Promise}
|
||
*/
|
||
|
||
async update(params, data, { files } = {}) {
|
||
const entry = await strapi.query(model).update(params, data);
|
||
|
||
if (files) {
|
||
// automatically uploads the files based on the entry and the model
|
||
await this.uploadFiles(entry, files, { model: strapi.models.restaurant });
|
||
return this.findOne({ id: entry.id });
|
||
}
|
||
|
||
return entry;
|
||
},
|
||
};
|
||
```
|
||
|
||
:::
|
||
|
||
::: tab delete
|
||
|
||
#### `delete`
|
||
|
||
```js
|
||
module.exports = {
|
||
/**
|
||
* Promise to delete a record
|
||
*
|
||
* @return {Promise}
|
||
*/
|
||
|
||
delete(params) {
|
||
return strapi.query('restaurant').delete(params);
|
||
},
|
||
};
|
||
```
|
||
|
||
:::
|
||
|
||
::: tab search
|
||
|
||
#### `search`
|
||
|
||
```js
|
||
module.exports = {
|
||
/**
|
||
* Promise to search records
|
||
*
|
||
* @return {Promise}
|
||
*/
|
||
|
||
search(params) {
|
||
return strapi.query('restaurant').search(params);
|
||
},
|
||
};
|
||
```
|
||
|
||
:::
|
||
|
||
::: tab countSearch
|
||
|
||
#### `countSearch`
|
||
|
||
```js
|
||
module.exports = {
|
||
/**
|
||
* Promise to count searched records
|
||
*
|
||
* @return {Promise}
|
||
*/
|
||
countSearch(params) {
|
||
return strapi.query('restaurant').countSearch(params);
|
||
},
|
||
};
|
||
```
|
||
|
||
:::
|
||
|
||
::::
|
||
|
||
## Custom services
|
||
|
||
You can also create custom services to build your own business logic.
|
||
|
||
### How to create a custom service
|
||
|
||
There are two ways to create a service.
|
||
|
||
- Using the CLI `strapi generate:service restaurant`. Read the [CLI documentation](../cli/CLI.md) for more information.
|
||
- Manually create a JavaScript file named in `./api/**/services/`.
|
||
|
||
#### Example
|
||
|
||
The goal of a service is to store reusable functions. An `email` service could be useful to send emails from different functions in our codebase:
|
||
|
||
**Path —** `./api/email/services/Email.js`.
|
||
|
||
```js
|
||
const nodemailer = require('nodemailer');
|
||
|
||
// Create reusable transporter object using SMTP transport.
|
||
const transporter = nodemailer.createTransport({
|
||
service: 'Gmail',
|
||
auth: {
|
||
user: 'user@gmail.com',
|
||
pass: 'password',
|
||
},
|
||
});
|
||
|
||
module.exports = {
|
||
send: (from, to, subject, text) => {
|
||
// Setup e-mail data.
|
||
const options = {
|
||
from,
|
||
to,
|
||
subject,
|
||
text,
|
||
};
|
||
|
||
// Return a promise of the function that sends the email.
|
||
return transporter.sendMail(options);
|
||
},
|
||
};
|
||
```
|
||
|
||
::: tip
|
||
please make sure you installed `nodemailer` (`npm install nodemailer`) for this example.
|
||
:::
|
||
|
||
The service is now available through the `strapi.services` global variable. We can use it in another part of our codebase. For example a controller like below:
|
||
|
||
**Path —** `./api/user/controllers/User.js`.
|
||
|
||
```js
|
||
module.exports = {
|
||
// GET /hello
|
||
signup: async ctx => {
|
||
// Store the new user in database.
|
||
const user = await User.create(ctx.params);
|
||
|
||
// Send an email to validate his subscriptions.
|
||
strapi.services.email.send(
|
||
'welcome@mysite.com',
|
||
user.email,
|
||
'Welcome',
|
||
'...'
|
||
);
|
||
|
||
// Send response to the server.
|
||
ctx.send({
|
||
ok: true,
|
||
});
|
||
},
|
||
};
|
||
```
|