PHPackages                             fr3on/magento2-lapis - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. fr3on/magento2-lapis

ActiveMagento2-module[API Development](/categories/api)

fr3on/magento2-lapis
====================

Automatic LAPIS lifecycle declarations for Magento 2 REST APIs

0.0.1(1mo ago)010MITPHPPHP >=8.1CI passing

Since Apr 14Pushed 1mo agoCompare

[ Source](https://github.com/fr3on/magento2-lapis)[ Packagist](https://packagist.org/packages/fr3on/magento2-lapis)[ RSS](/packages/fr3on-magento2-lapis/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependenciesVersions (2)Used By (0)

Magento 2 LAPIS
===============

[](#magento-2-lapis)

[![Build Status](https://github.com/fr3on/magento2-lapis/actions/workflows/tests.yml/badge.svg)](https://github.com/fr3on/magento2-lapis/actions/workflows/tests.yml/badge.svg)[![License](https://camo.githubusercontent.com/e3a76cec02e1cf39d51cf17037f3ee7f63bbae8c069f4670cf3c29af71f7ce10/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6672336f6e2f6d6167656e746f322d6c61706973)](https://camo.githubusercontent.com/e3a76cec02e1cf39d51cf17037f3ee7f63bbae8c069f4670cf3c29af71f7ce10/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6672336f6e2f6d6167656e746f322d6c61706973)[![Packagist Downloads](https://camo.githubusercontent.com/8eb65ac6fcb935fb3d1e0c1424540868b724a9edaf65f758dfe3f334348785cf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6672336f6e2f6d6167656e746f322d6c61706973)](https://camo.githubusercontent.com/8eb65ac6fcb935fb3d1e0c1424540868b724a9edaf65f758dfe3f334348785cf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6672336f6e2f6d6167656e746f322d6c61706973)

Automatic LAPIS (Lifecycle & Protocol Intent Specification) declarations for Magento 2 REST APIs.

Mission
-------

[](#mission)

This composer package automatically generates LAPIS declarations from a live Magento 2 installation. It introspects what Magento already knows—Order statuses, Transitions, State-to-Status mappings—and surfaces it in a form every system can consume.

**Read-only.** This module never writes to Magento's own tables. It only reads.

Installation
------------

[](#installation)

```
composer require fr3on/magento2-lapis
bin/magento module:enable Fr3on_Lapis
bin/magento setup:upgrade
```

Features
--------

[](#features)

- **RLD Generator:** Produces valid YAML/JSON for Order, Invoice, Credit Memo, Shipment, and Cart.
- **REST Response Headers:** Every API response includes `X-LAPIS-State` and `X-LAPIS-Transitions`.
- **Admin Visualizer:** Interactive state machine graphs at `System > LAPIS`.
- **CLI Tools:** Generate and validate declarations from the terminal.

Usage
-----

[](#usage)

### CLI Commands

[](#cli-commands)

```
bin/magento lapis:generate    # Generates YAML files in var/lapis/
bin/magento lapis:validate    # Validates generated files against schema
```

### Extending via `lapis.xml`

[](#extending-via-lapisxml)

You can declare custom transitions or override heuristics by creating a `lapis.xml` in your module's `etc` directory:

```

```

Dashboard
---------

[](#dashboard)

Navigate to **System > LAPIS** in the Magento Admin to see the live state machine of your store.

License
-------

[](#license)

MIT

###  Health Score

34

—

LowBetter than 75% of packages

Maintenance89

Actively maintained with recent releases

Popularity5

Limited adoption so far

Community3

Small or concentrated contributor base

Maturity32

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

56d ago

### Community

---

Top Contributors

[![fr3on](https://avatars.githubusercontent.com/u/26393383?v=4)](https://github.com/fr3on "fr3on (31 commits)")

---

Tags

apilapislifecyclemagentomagento2oipphprestrldstate-machine

### Embed Badge

![Health badge](/badges/fr3on-magento2-lapis/health.svg)

```
[![Health](https://phpackages.com/badges/fr3on-magento2-lapis/health.svg)](https://phpackages.com/packages/fr3on-magento2-lapis)
```

###  Alternatives

[facebook/php-business-sdk

PHP SDK for Facebook Business

90923.5M35](/packages/facebook-php-business-sdk)[exsyst/swagger

A php library to manipulate Swagger specifications

35916.3M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24015.5M18](/packages/hubspot-api-client)[botman/driver-telegram

Telegram driver for BotMan

93452.6k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)