PHPackages                             woutersf/mautic-openapi-bundle - 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. woutersf/mautic-openapi-bundle

ActiveMautic-plugin[API Development](/categories/api)

woutersf/mautic-openapi-bundle
==============================

Exposes a public OpenAPI 3.1.0 specification endpoint and Swagger UI viewer for the Mautic REST API.

00PHP

Since Mar 26Pushed 3mo agoCompare

[ Source](https://github.com/woutersf/MauticOpenApiBundle)[ Packagist](https://packagist.org/packages/woutersf/mautic-openapi-bundle)[ RSS](/packages/woutersf-mautic-openapi-bundle/feed)WikiDiscussions main Synced 3w ago

READMEChangelogDependenciesVersions (1)Used By (0)

Mautic OpenAPI Bundle
=====================

[](#mautic-openapi-bundle)

A Mautic plugin that generates and exposes an **OpenAPI 3.1.0 specification** for the Mautic REST API, with a built-in **Swagger UI** explorer.

Features
--------

[](#features)

- Serves the full **OpenAPI 3.1.0** spec at `/openapi` (JSON or YAML)
- Interactive **Swagger UI** at `/openapi/view` (loaded from CDN, zero install)
- Respects the Mautic API enabled/disabled setting
- Optional login gate: toggle between public and authenticated-only access
- Enable/disable via the standard Mautic Plugins screen

Requirements
------------

[](#requirements)

- Mautic 4.x or 5.x
- PHP 8.1+
- Mautic REST API enabled (**Configuration → API Settings**)

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

[](#installation)

Copy `MauticOpenApiBundle/` into your Mautic `plugins/` directory, then clear the cache:

```
php bin/console cache:clear
```

Go to **Settings → Plugins**, find **OpenAPI Specification** and enable it.

Endpoints
---------

[](#endpoints)

URLResponseDescription`/openapi``application/json`OpenAPI 3.1.0 spec`/openapi?format=yaml``application/yaml`Same spec in YAML`/openapi/view``text/html`Swagger UI explorerThe spec and viewer honour the same availability gate: both return `503` if the plugin or the Mautic API is disabled.

Configuration
-------------

[](#configuration)

Under **Configuration → OpenAPI Settings**:

SettingDefaultDescriptionPublicly availableYesWhen **No**, `/openapi` returns `401 Unauthorized` and `/openapi/view` redirects to the Mautic login pageAPI coverage
------------

[](#api-coverage)

The OpenAPI spec documents all standard Mautic REST API resources:

Swagger UI
----------

[](#swagger-ui)

The `/openapi/view` page loads [Swagger UI v5](https://swagger.io/tools/swagger-ui/) from a CDN and points it at this instance's `/openapi` endpoint. Features enabled by default:

- Try-it-out (live API calls against this Mautic instance)
- Persistent authorization across page reloads
- Filter / search across all endpoints
- Deep linking to specific operations

About the spec
--------------

[](#about-the-spec)

The spec is generated at runtime so the `servers.url` always reflects the current Mautic instance URL. Format negotiation supports:

- Query param: `?format=yaml`
- Accept header: `application/yaml`, `text/yaml`, `application/x-yaml`

License
-------

[](#license)

[GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.html): same as Mautic.

---

Built by [Dropsolid](https://dropsolid.ai)

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance55

Moderate activity, may be stable

Popularity0

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity12

Early-stage or recently created project

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/42bc3b27606ef65745245b440198e05a62e85dea0ba9f62f2ff2361bfbf1b146?d=identicon)[woutersf](/maintainers/woutersf)

### Embed Badge

![Health badge](/badges/woutersf-mautic-openapi-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/woutersf-mautic-openapi-bundle/health.svg)](https://phpackages.com/packages/woutersf-mautic-openapi-bundle)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

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

Hubspot API client

24015.5M18](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172437.8k11](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93452.6k6](/packages/botman-driver-telegram)[pixelant/pxa-social-feed

Add Facebook, Instagram, and Twitter feeds to your site.

2349.3k](/packages/pixelant-pxa-social-feed)

PHPackages © 2026

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