PHPackages                             jastrzebski/swaggier - 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. [CLI &amp; Console](/categories/cli)
4. /
5. jastrzebski/swaggier

ActiveLibrary[CLI &amp; Console](/categories/cli)

jastrzebski/swaggier
====================

CLI app that builds OpenApi 3.0.0 documentation by sending request to selected RestApi.Works only with JSON format (Response) and provides GET, POST, PUT, PATCH and DELETE http request.

0.3(3y ago)011MITPHPPHP &gt;=8.1

Since Nov 16Pushed 3y ago1 watchersCompare

[ Source](https://github.com/marekjastrzebski/Swaggier)[ Packagist](https://packagist.org/packages/jastrzebski/swaggier)[ RSS](/packages/jastrzebski-swaggier/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (1)Versions (5)Used By (0)

SWAGGIER
========

[](#swaggier)

Install
-------

[](#install)

```
composer require jastrzebski/swaggier
```

Description
-----------

[](#description)

It builds OpenApi 3.0.0 documentation by sending request to selected RestApi. Works only with JSON format (Response) and provides GET, POST, PUT, PATCH and DELETE http request.

Usage
-----

[](#usage)

### Basic

[](#basic)

Fist you have to build json with request schema with looks like this

```
[
  {
    "url": "https://localhost:3000",
    "endpoint": "/test/{id}",
    "method": "get",
    "headers": [
      "Content-type: application/json"
    ],
    "parameters": {
      "id": 1
    }
  },
  {
    "url": "https://localhost:3000",
    "endpoint": "/test",
    "method": "get",
    "headers": [
      "Content-type: application/json"
    ]
  },
  {
    "url": "https://localhost:3000",
    "endpoint": "/test",
    "method": "post",
    "headers": [
      "Content-type: application/json"
    ],
    "request": {
      "name": "Marek",
      "surname": "Jastrzebski",
      "age": 33,
      "luckyNumber": 0.23,
      "others": {
        "hobby" : ["reading", "cleaning"],
        "programingLangs": {
          "php": true,
          "Java": false
        },
        "badname": "phr"
      }
    }
  }
]
```

### Request Elements

[](#request-elements)

#### url

[](#url)

Please pass url w/o endpoint and no slash at the end of address.

#### endpoint

[](#endpoint)

Please pass endpoint, if you want to pass any parameter please set its name in { }.

##### method

[](#method)

Please set method that you want to use to send this request.

#### headers

[](#headers)

Please pass all headers that you want to send with request. Always set it as an array.

#### parameters (optional)

[](#parameters-optional)

Please set this element only when you want to pass any parameter in query(url). Names have to be same like in query.

#### request (optional)

[](#request-optional)

Please pass JSON request body

Run
---

[](#run)

If you want to run strict request from your request.json use this command

```
vendor/bin/swaggier -r=request.json
```

It will output swaggier.json file that contains OpenApi 3.0 description.

But if you want to run some alternative scenarios that can generate other responses

```
vendor/bin/swaggier -r=request.json -b=true
```

It will run scenarios "Original", "No Headers", "No Request", "Type Juggling"

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 77.8% 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

Every ~4 days

Total

3

Last Release

1266d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e8eec7021fd63e90c9d83aae12859f0bf086474f2fb0a50c8f37edf9688fd225?d=identicon)[marek.jastrzebski](/maintainers/marek.jastrzebski)

---

Top Contributors

[![Jastrzmarek](https://avatars.githubusercontent.com/u/97914316?v=4)](https://github.com/Jastrzmarek "Jastrzmarek (14 commits)")[![marekjastrzebski](https://avatars.githubusercontent.com/u/114880557?v=4)](https://github.com/marekjastrzebski "marekjastrzebski (4 commits)")

---

Tags

requestjsoncliswaggeropenapigeneratordescriptionintegrationcommunicationrestapiSwaggier

### Embed Badge

![Health badge](/badges/jastrzebski-swaggier/health.svg)

```
[![Health](https://phpackages.com/badges/jastrzebski-swaggier/health.svg)](https://phpackages.com/packages/jastrzebski-swaggier)
```

###  Alternatives

[timwassenburg/laravel-repository-generator

Generate Laravel repositories

2116.9k1](/packages/timwassenburg-laravel-repository-generator)[proophsoftware/prooph-bundle

Symfony bundle for prooph components to get started out of the box with message bus, CQRS, event sourcing and snapshots

164.3k](/packages/proophsoftware-prooph-bundle)[timwassenburg/laravel-artisan-extender

A collection of generators for Laravel

111.4k](/packages/timwassenburg-laravel-artisan-extender)

PHPackages © 2026

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