PHPackages                             njuhel/swagger-to-md - 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. [Utility & Helpers](/categories/utility)
4. /
5. njuhel/swagger-to-md

AbandonedArchivedPackage[Utility & Helpers](/categories/utility)

njuhel/swagger-to-md
====================

Tranform a swagger (multifile or plainfile) into markdown doc file based on template files. The generated doc is more a sskeltton of doc than a full finished doc file (depends of the documentation into your swagger file)

126PHP

Since Sep 5Pushed 9y agoCompare

[ Source](https://github.com/njuhel/php-swagger-to-md)[ Packagist](https://packagist.org/packages/njuhel/swagger-to-md)[ RSS](/packages/njuhel-swagger-to-md/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (2)Used By (0)

[![Dependency Status](https://camo.githubusercontent.com/6e2b3788878c359a83df21de63a2e34aff697af842a1133e5b513db68049ae86/68747470733a2f2f67656d6e617369756d2e636f6d2f6261646765732f6769746875622e636f6d2f6e6a7568656c2f7068702d737761676765722d746f2d6d642e737667)](https://gemnasium.com/github.com/njuhel/php-swagger-to-md) ~ [![Code Climate](https://camo.githubusercontent.com/e775be73ecc50668889ddfefc625ab802d0c0d8610cdf88114c5f984e0889b3c/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f6e6a7568656c2f7068702d737761676765722d746f2d6d642f6261646765732f6770612e737667)](https://codeclimate.com/github/njuhel/php-swagger-to-md) ~ [![Test Coverage](https://camo.githubusercontent.com/f0b7ddf2ed0c2a45fa5eb4cc1744b552e26b36024abc3ede888a839745d7e8b5/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f6e6a7568656c2f7068702d737761676765722d746f2d6d642f6261646765732f636f7665726167652e737667)](https://codeclimate.com/github/njuhel/php-swagger-to-md/coverage) ~ [![Travis branch](https://camo.githubusercontent.com/ceac8a1e03ea853965b1c9c741e318169b7dec641f495b3bf374c74406d245e8/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6e6a7568656c2f7068702d737761676765722d746f2d6d642f6d61737465722e7376673f6d61784167653d363030266c6162656c3d504850253230352e352532302d2d372e30)](https://travis-ci.org/njuhel/php-swagger-to-md)

***PHP* Swagger To Markdown (md)**
==================================

[](#php-swagger-to-markdown-md)

##### Transform a swagger (multifile / monofile) into md documents based on templates

[](#transform-a-swagger-multifile--monofile-into-md-documents-based-on-templates)

A Swagger(OpenAPI) transformation to on markdown file as helper based on the PHP Swagger Validator. Having a md doc file based on a swagger file is interesting to having plain file to explain what is need for each exposed resources

Swagger is old name of [OpenAPI Projet](https://openapis.org/) and who manage the [OAI Specification](https://github.com/OAI/OpenAPI-Specification/tree/master/schemas/)

**Need to do**
--------------

[](#need-to-do)

- realse a first version

**Compatibility**
-----------------

[](#compatibility)

***Help us to fix error with compatibilities***

- scope PHP 5.5 to PHP 7.0

**Installation Guide**
----------------------

[](#installation-guide)

- Install into a git repository as submodule :

```
git submodule init
git submodule add --branch v1.0.x https://github.com/njuhel/php-swagger-to-md build/lib/swagger-to-md
git submodule update
```

- Install by cloning git :

```
git clone --branch v1.0.x https://github.com/njuhel/php-swagger-to-md swagger-to-md
```

- Install with composer (adding this in composer.json):

```
    "require": {
        "njuhel/swagger-to-md":">=1.0.0"
    },
```

- Install with phar :

```
wget https://github.com/njuhel/php-swagger-to-md/raw/v1.0.x/bin/Swagger-to-md.phar
```

**Example & Docs**
----------------------

[](#example--docs)

- **Examples** : [Example.php](https://github.com/njuhel/php-swagger-to-md/blob/v1.0.x/src/Swagger-to-md/Example.php)
- **Documentation** : [generated](https://github.com/njuhel/php-swagger-to-md/blob/v1.0.x/doc/README.md)

###  Health Score

21

—

LowBetter than 19% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/f0b7b53ddb4c0b4245d55d3607cbba83c11dd915a26ed3fbc5f1ed77d7688cbd?d=identicon)[njuhel](/maintainers/njuhel)

---

Top Contributors

[![nabbar](https://avatars.githubusercontent.com/u/19818221?v=4)](https://github.com/nabbar "nabbar (100 commits)")

### Embed Badge

![Health badge](/badges/njuhel-swagger-to-md/health.svg)

```
[![Health](https://phpackages.com/badges/njuhel-swagger-to-md/health.svg)](https://phpackages.com/packages/njuhel-swagger-to-md)
```

###  Alternatives

[naux/auto-correct

12511.4k2](/packages/naux-auto-correct)[kss-php/kss-php

A PHP implementation of KSS: a methodology for documenting CSS and generating styleguides

25142.7k2](/packages/kss-php-kss-php)[leedavis81/vent

PHP variable events.

814.6k](/packages/leedavis81-vent)[hiqdev/yii2-cart

Cart module for Yii2

1616.2k](/packages/hiqdev-yii2-cart)

PHPackages © 2026

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