Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #48

Merged
merged 2 commits into from
Apr 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
11 changes: 8 additions & 3 deletions doc/01_Installation.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Installation of the Studio Api Bundle
# Installation of the Studio Backend Bundle

:::info

This bundle is only supported on Pimcore Core Framework 11.

:::

## 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:

Expand All @@ -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)
Binary file added doc/img/swagger-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading