dbp/relay-sublibrary-bundle

v0.4.10 2024-09-11 10:02 UTC

README

GitHub | Packagist | 前端应用程序

Test

免责声明:此组件需要特定的ALMA配置才能工作。如需更多信息,请联系 info@digital-blueprint.org

此Symfony 4.4组件为以下API端点提供支持

  • 为书籍分配索书号
  • 从子图书馆借阅书籍
  • 将书籍归还到子图书馆
  • 延长书籍的借阅期限
  • 显示子图书馆的图书列表
  • 显示子图书馆当前的借阅情况
  • 显示子图书馆当前的图书订单

用于API网关。

有一个对应的前端应用程序使用此API,位于 子图书馆前端应用程序

先决条件

  • 具有openAPI/Swagger的API网关
  • 具有特殊配置的Alma后端访问权限(用于分析)

组件安装

您可以从 packagist.org 直接安装组件。

composer require dbp/relay-sublibrary-bundle

集成到API服务器

  • 将必要的组件添加到您的 config/bundles.php
...
Dbp\Relay\SublibraryBundle\DbpRelaySublibraryBundle::class => ['all' => true],
Dbp\Relay\CoreBundle\DbpRelayCoreBundle::class => ['all' => true],
];
  • 运行 composer install 清除缓存

配置

组件具有配置值,您可以在应用程序中指定这些值,方法是通过硬编码或引用环境变量。

为此,在应用程序中创建 config/packages/dbp_relay_sublibrary.yaml,内容如下

dbp_relay_sublibrary:
  api_url: '%env(ALMA_API_URL)%'
  api_key: '%env(ALMA_API_KEY)%'
  analytics_api_key: '%env(ALMA_ANALYTICS_API_KEY)%'
  readonly: '%env(bool:ALMA_READONLY)%'

您的 .env 文件应包含以下环境变量,用于配置组件

###> dbp/relay-sublibrary-bundle ###
ALMA_API_URL=https://api-eu.hosted.exlibrisgroup.com/almaws/v1
ALMA_API_KEY=
ALMA_ANALYTICS_API_KEY=
ALMA_READONLY=
###< dbp/relay-sublibrary-bundle ###

如果您使用 DBP API Server Template 作为您Symfony应用程序的模板,则配置文件应已为您生成。

有关组件配置的更多信息,请参阅 https://symfony.com.cn/doc/current/bundles/configuration.html