Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digital-blueprint/relay-sublibrary-bundle
Symfony bundle provides API endpoints communication with ALMA
https://github.com/digital-blueprint/relay-sublibrary-bundle
alma dbp digital-blueprint sublibrary symfony symfony-bundle
Last synced: 2 months ago
JSON representation
Symfony bundle provides API endpoints communication with ALMA
- Host: GitHub
- URL: https://github.com/digital-blueprint/relay-sublibrary-bundle
- Owner: digital-blueprint
- Created: 2023-01-26T14:25:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T04:13:27.000Z (8 months ago)
- Last Synced: 2024-04-15T00:16:19.331Z (8 months ago)
- Topics: alma, dbp, digital-blueprint, sublibrary, symfony, symfony-bundle
- Language: PHP
- Homepage: https://packagist.org/packages/dbp/relay-sublibrary-bundle
- Size: 1.16 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Dbp Relay SubLibrary Bundle
[GitHub](https://github.com/digital-blueprint/relay-sublibrary-bundle) |
[Packagist](https://packagist.org/packages/dbp/relay-sublibrary-bundle) |
[Frontend Application](https://gitlab.tugraz.at/dbp/sublibrary/sublibrary)
[](https://github.com/digital-blueprint/relay-sublibrary-bundle/actions/workflows/test.yml)
DISCLAIMER: This bundle needs a specific ALMA configuration to work. Please contact [[email protected]](mailto:[email protected]) for more information.
This Symfony 4.4 bundle provides API endpoints for
- assigning a call number to a book
- borrowing a book from the sublibrary
- returning a book to the sublibrary
- extending a loan period for a book
- showing sublibrary's book list
- showing sublibrary's current loans
- showing sublibrary's current book orders
for the API-Gateway.
There is a corresponding frontend application that uses this API at [Sublibrary Frontend Application](https://gitlab.tugraz.at/dbp/sublibrary/sublibrary).
## Prerequisites
- API Gateway with openAPI/Swagger
- Alma backend access with special configuration (for analytics)
## Bundle installation
You can install the bundle directly from [packagist.org](https://packagist.org/packages/dbp/relay-sublibrary-bundle).
```bash
composer require dbp/relay-sublibrary-bundle
```
## Integration into the API Server
* Add the necessary bundles to your `config/bundles.php`:
```php
...
Dbp\Relay\SublibraryBundle\DbpRelaySublibraryBundle::class => ['all' => true],
Dbp\Relay\CoreBundle\DbpRelayCoreBundle::class => ['all' => true],
];
```
* Run `composer install` to clear caches
## Configuration
The bundle has configuration values that you can specify in your app, either by hardcoding it,
or by referencing an environment variable.
For this create `config/packages/dbp_relay_sublibrary.yaml` in the app with the following
content:
```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)%'
```
Your `.env` file should then contain the following environment variables you need to configure the bundle:
```dotenv
###> 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 ###
```
If you were using the [DBP API Server Template](https://gitlab.tugraz.at/dbp/relay/dbp-relay-server-template)
as template for your Symfony application, then the configuration files should have already been generated for you.
For more info on bundle configuration see .