[筆記] Strapi v4 的 API Public 公開存取注意事項 @地瓜大的飛翔旅程

章節連結

內容

新增一個集合型別或單一型別，要額外進設定打開讀取權限
Swagger 文件的伺服器位置，要在 plugins.ts 設定
若要取得圖片、影片…等資料，要額外下 populate 的參數

Strapi v4 的公開 API 存取的設定會需要花一點心思，以免給他人測試時都是 403 Forbidden。

內容

新增一個集合型別或單一型別，要額外進設定打開讀取權限

位置在「設定 -> 使用者與權限外掛程式(角色) -> 權限 (將 find/findOne) 打開」

Swagger 文件的伺服器位置，要在 plugins.ts 設定

{
  documentation: {
    enabled: true,
    config: {
                openapi: '3.0.0',
                info: {
                    version: '1.0.0',
                    title: 'DOCUMENTATION',
                    license: {
                        name: 'Apache 2.0',
                        url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
                    },
                },
                'x-strapi-config': {
                    // Leave empty to ignore plugins during generation
                    plugins: [ 'upload', 'users-permissions'],
                    path: '/documentation'
                },
                servers: [
                    { url: `${env('SERVER_URL')}/api`}
                ],
                externalDocs: {
                    description: 'Find out more',
                    url: 'https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html'
                },
                security: [ { bearerAuth: [] } ]
            }
        }
}