Strapi CMS 使用手册

Roadmap: 真的有好多还没开发完成的实用功能

安装与配置

常用命令

export PORT=3000 && npm run develop	# 更改启动端口

配置文件

// config/server.js, Server相关配置
module.exports = ({ env }) => ({
  host: env('HOST', process.env.HOST),
  port: env.int('PORT', process.env.PORT),
  admin: {
    url: 'admin',	// 可以修改默认的后台路径，但是不能设置为/ root路径，关注https://github.com/strapi/strapi/issues/9302
    auth: {
      secret: env('ADMIN_JWT_SECRET', process.env.ADMIN_JWT_SECRET),
    },
  },
});

// config/api.js, API相关配置
module.exports = ({ env }) => ({
  responses: {
    privateAttributes: ['_v', 'id', 'created_at'],
  },
  rest: {
    defaultLimit: 100,
    maxLimit: 250,
  },
});

// config/plugins.js, 插件相关配置
module.exports = {
  graphql: {	// graphql插件相关配置
    endpoint: '/graphql',
    shadowCRUD: true,
    playgroundAlways: false,
    depthLimit: 7,
    amountLimit: 100,
    apolloServer: {
      tracing: false,
    }
  }
}

// extensions/users-permissions/config/security.json, 修改jwt token的配置
{
  "jwt": {
    "expiresIn": "3650d"
  }
}

// .env, 有几个默认的Strapi相关的配置，例如是否开启更新提示等，默认都是关闭了的

自定义Role及权限

免费版不能在web端直接进行配置，不过可以修改数据库，看一下数据库的表结构就能很好修改了，但问题是每次修改了types结构以后需要重新分配role的权限，否则权限会丢失，可以使用以下代码在重新启动应用时自动更新权限，但还是有个问题，如果应用不完全重启，仍然不会更新，因为应用没有完全重启的话admin的也不会更新的:

// config/functions/bootstrap.js
"use strict";

const lodash = require('lodash');

// Prevent permissions loss
const setDefaultRolePermissions = async () => {
  const adminRole = await strapi.query("role", "admin").findOne({id: 1});
  const customRoles = await strapi.query("role", "admin").find({id_gt: 3});

  customRoles.forEach(customRole => {
    console.log(`Check ${customRole.name} permissions`);
    customRole.permissions.forEach(permission => {
      // compare permission fields with adminRole
      const realPermission = adminRole.permissions.find(p => p.action === permission.action && p.subject === permission.subject)
      if (permission.properties.fields && permission.action.includes('plugins::content-manager.explorer') &&(permission.properties.fields.length !== realPermission.properties.fields.length ||
        permission.properties.fields.length !== lodash.uniq(permission.properties.fields.concat( realPermission.properties.fields)).length)) {
        strapi.query("permission", "admin").update({id: permission.id}, {properties: realPermission.properties})
      }
    })
  })
};


module.exports = async () => {
  setTimeout(setDefaultRolePermissions, 3000);	// 使用timeout是因为刚重启的时候数据库还没根据新的结构更新
};

升级步骤

升级非常简单，直接在composer.json里面全局替换，例如将3.5.2全部替换成3.6.1，在执行以下命令即可

npm install
rm -rf .cache && rm -rf build/

修改admin系统文件

只需要参照node_modules/strapi-admin/中的目录结构，在根目录新建admin文件夹与其保持一致，任何想要覆盖的都可以放在这里
替换logo，可以在admin/src/assets/images中放置

其他特性

Controllers

return ctx.badRequest({ error: 'Parameter is empty' }) // 返回400错误
return ctx.notFound('Product not found')	// 返回404错误

Services

await strapi.query('user', 'users-permissions').findOne({id:13})	// 查询用户

Hooks

Middlewares

有一些自带的中间件: favicon、public、session、logger、parser、gzip、responseTime、poweredBy，安全相关的有csp、p3p、hsts、xframe、xss、cors、ip(可以设置黑白名单)

Functions

./config/functions目录下，这里面的函数可以用trapi.config.functions['fileName']()来调用
bootstrap.js每启动都会执行

定时获取外部数据

支持定时从外部获取数据并存储到数据库中，不过我没玩儿过，可以参考这里

API集成

这里列举了各个前端如何使用API的方法
调用API如果开启了认证，那么就得用一个user来用接口登录获取jwt token，并且这里的user和登录用户不一样，需要重新注册才行，并且默认都可以注册，注册了一个后可以在USERS & PERMISSIONS PLUGIN -> Advanced Settings去关闭注册功能

graphql

服务端需要先安装strapi install graphql，客户端也需要安装npm install @apollo/client graphql

// 登录获取jwt token
mutation {
  login(input: { identifier: "email", password: "password" }) {
    jwt
  }
}

{
  products (where: {slug: ""}, publicationState:LIVE, limit: 1})	// 如果是findone不支持除id以外的参数拿来查询，findall可以
}

外部插件

Cloudinary支持官方文档

集成步骤

安装npm install strapi-provider-upload-cloudinary graphql --save

在config/plugins.js中添加upload配置:

module.exports = ({ env }) => ({
    // ...
    upload: {
      provider: 'cloudinary',
      providerOptions: {
        cloud_name: env('CLOUDINARY_NAME'),
        api_key: env('CLOUDINARY_KEY'),
        api_secret: env('CLOUDINARY_SECRET'),
      },
    },
    // ...
  });

支持上传至指定目录

官方的这个插件默认不支持指定上传目录，可以关注这个issue，也不知道他们怎么想的，如果要支持自定义目录或者其他clodinary配置，可以用strapi-provider-upload-cloudinary-folderoptions，但是它有个问题就是upload from url的时候会把那个url当成目录层级，可是url本身放到url中会报错
第二种方法就是自己修改一下官方那个插件即可，挺简单的：
1. 修改package.json添加依赖: strapi-provider-upload-cloudinary-folder: "file:providers/strapi-provider-upload-cloudinary-folder"
2. 修改config/plugin.js，将upload.provider修改为cloudinary-folder，并且在providerOptions中添加参数folder: env('CLOUDINARY_DEFAULT_FOLDER')
复制package.json内容到providers/strapi-provider-upload-cloudinary-folder/package.json并修改name为strapi-provider-upload-cloudinary-folder

复制index.js内容到providers/provider-upload-cloudinary-folder/index.js简单修改一下将配置传入:

init(config) {
    cloudinary.config(config);
    const folder = config.folder;

    return {
      upload(file, customConfig = {}) {
        return new Promise((resolve, reject) => {
          const config = {
            resource_type: 'auto',
            public_id: file.hash,
            folder,
          };
          
          ...
        }
}

strapi-tinymce 集成tinymce