https://github.com/angular-buch/api6
https://github.com/angular-buch/api6
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/angular-buch/api6
- Owner: angular-buch
- Created: 2023-02-02T14:15:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-11T21:13:18.000Z (over 1 year ago)
- Last Synced: 2025-01-11T22:22:15.913Z (over 1 year ago)
- Language: CSS
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BookMonkey API 6
This is the API for the BookMonkey application from the [German Angular Book](https://angular-buch.com). It is a RESTful API that provides CRUD operations for books.
A publicly available server is hosted at [api6.angular-buch.com](https://api6.angular-buch.com).
## Installation
> :warning: **You don't need to install this project to use the API. Please use the public server at [api6.angular-buch.com](https://api6.angular-buch.com).**
The `public` folder must contain an `.env` file with MySQL credentials.
Copy the `.env.example` to `.env`.
Dependencies are managed with composer. Run in the project root to install all deps:
```bash
composer install
```
## Swagger UI
The `swagger-ui` package is installed as a dependency via `composer`.
The served directory `public/swagger-ui` is a symlink to the `swagger-ui` package in the `vendor` folder.
To be able to configure Swagger UI, an Apache rewrite rule replaces the predefined config with our own version (`public/swagger-initializer.js`).