Skip to main content
Version: 10.x

Architecture

Porto SAP​

Introduction​

Porto is the default and recommended architecture for building apps on Apiato.

Apiato also supports the popular MVC architecture (with a little modifications). The Apiato features are written using Porto, but can be used by any architecture.

About Porto​

Porto is an architecture that consists of 2 layers the Containers layer and Ship layer.

The Containers layer consists of Containers. These containers are grouped into isolated Sections, to easily move them around.

  • A Container can be a feature, or can be a wrapper around a RESTful API resource, or anything else. A container is allowed to depend on other containers.
  • A Section (is a group of related containers), it can be service (micro or bigger), or a sub-system within the main system, or antyhing else. A Section is not allowed to directly communicate with another service, except via Events or Commands.

The default Apiato Sections:

  • The App Section: is the only default section Apiato provides, it contains all the default containers. You can create additional sections anytime, and rename them to anything you want. (ex: Inventory Section, Shipping Section, Order Section, Payment Section...)
  • The Vendor: is a special Section, it only contains installed and reusable Containers. Similar to the vendor directory at the root. Any Section is allowed to depend on the Vendor Section.

Spending 30 minutes, reading the Porto Document before getting started, is a great investment of time.

Create a custom Container​

Using the Code Generator:​

php artisan apiato:generate:container

Refer to the code generator page for more details.

Container Conventions​

  • Containers name SHOULD start with Capital. Use CamelCase to rename Containers.
  • Namespace should be the same as the container name, (if container name is "Printer" the namespace should be App\Containers\SectionName\Printer).
  • Container MAY be named anything, however a good practice is to name it to its most important Model name. Example: If the User Story is (User can create a Store and Store can have Items) then we you could have 3 Containers (User, Store and Item).