diff --git a/README.md b/README.md index 50dba93b4..32835a5f5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ -# Studio Api -todo +--- +title: Studio Backend +--- -## Features in a Nutshell +# Pimcore Studio Backend +The Pimcore Studio Backend serves as the central hub for API endpoints and RPC calls. +It provides a unified interface based on the OpenApi Specification for all backend calls which is accessible via swagger-ui. + +![Swagger UI](./doc/img/swagger-ui.png) + +It uses [zircote/swagger-php](https://github.com/zircote/swagger-php) attributes to generate the OpenApi Specification. + +Swagger-ui is available at `/studio/api/docs` and the OpenApi Specification is available at `/studio/api/docs.json`. ## Documentation Overview + - [Installation](./doc/01_Installation.md) diff --git a/doc/01_Installation.md b/doc/01_Installation.md index 9e1b939b0..f6ee5a77d 100644 --- a/doc/01_Installation.md +++ b/doc/01_Installation.md @@ -1,4 +1,4 @@ -# Installation of the Studio Api Bundle +# Installation of the Studio Backend Bundle :::info @@ -6,9 +6,9 @@ ::: - ## Bundle Installation +## Bundle Installation -To install the Studio Api Bundle, follow the three steps below: +To install the Studio Backend Bundle, follow the three steps below: 1) Install the required dependencies: @@ -33,3 +33,8 @@ return [ ```bash bin/console pimcore:bundle:install PimcoreStudioBackendBundle ``` + +## Setting up generic data index +Pimcore Studio Backend also requires the installation and setup of the generic data index. +The bundle is required by default and also automatically enabled in the bundles. +To install the generic data index refer to [Generic-Data-Index](https://github.com/pimcore/generic-data-index-bundle?tab=readme-ov-file) \ No newline at end of file diff --git a/doc/img/swagger-ui.png b/doc/img/swagger-ui.png new file mode 100644 index 000000000..475277c4c Binary files /dev/null and b/doc/img/swagger-ui.png differ