Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1022 Bytes

README.md

File metadata and controls

23 lines (15 loc) · 1022 Bytes

BookMonkey API 6

This is the API for the BookMonkey application from the German Angular Book. It is a RESTful API that provides CRUD operations for books. A publicly available server is hosted at api6.angular-buch.com.

Installation

⚠️ You don't need to install this project to use the API. Please use the public server at 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:

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).