PHPackages                             fgsl/swagger-docs - 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. fgsl/swagger-docs

ActiveComponent[API Development](/categories/api)

fgsl/swagger-docs
=================

Swagger Documentation Generator

1.3.1(7mo ago)01AGPL-3.0-onlyPHPPHP >=7.2CI failing

Since Dec 26Pushed 7mo ago1 watchersCompare

[ Source](https://github.com/fgsl/swagger-docs)[ Packagist](https://packagist.org/packages/fgsl/swagger-docs)[ Docs](https://github.com/fgsl/swagger-docs)[ RSS](/packages/fgsl-swagger-docs/feed)WikiDiscussions master Synced 1mo ago

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

Installation in a PHP project
=============================

[](#installation-in-a-php-project)

Run command:

```
composer require fgsl/swagger-docs

```

For getting Composer:

How to use
==========

[](#how-to-use)

See sample below:

```
vendor/bin/fsd
```

Defaults: **source directory:** src/ **target directory:** public/.

For an alternative source directory, pass the directory name as first argument.

For an alternative target directory, pass the directory name as second argument.

So:

```
vendor/bin/fsd [sourceDirectory] [targetDirectory]
```

\[sourceDirectory\] and \[targetDirectory\] are relative to root directory of application.

Build
=====

[](#build)

```
vendor/bin/phing
```

Dependency
==========

[](#dependency)

This project depends on [swagger-php](https://zircote.github.io/swagger-php).

Attributes
==========

[](#attributes)

Use attributes for generating SWagger documentation.

Read about attributes in [swagger-php attributes](https://zircote.github.io/swagger-php/guide/attributes.html) topic.

But maybe you can learn better by [examples](https://zircote.github.io/swagger-php/guide/examples.html).

Model for API page
==================

[](#model-for-api-page)

The following page shows the documentation generated by this component. You only need to replace \[WEB ROOT ROUTE\] bu the root URL of your application.

For example, for a Laminas PHP application, \[WEB ROOT ROUTE\] is ``.

```

>

    Swagger UI

      html
      {
        box-sizing: border-box;
        overflow: -moz-scrollbars-vertical;
        overflow-y: scroll;
      }

      *,
      *:before,
      *:after
      {
        box-sizing: inherit;
      }

      body
      {
        margin:0;
        background: #fafafa;
      }

    window.onload = function() {
      // Begin Swagger UI call region
      const ui = SwaggerUIBundle({
        //url: "https://petstore.swagger.io/v2/swagger.json",
        spec : spec,
        dom_id: '#swagger-ui',
        deepLinking: true,
        presets: [
          SwaggerUIBundle.presets.apis,
          SwaggerUIStandalonePreset
        ],
        plugins: [
          SwaggerUIBundle.plugins.DownloadUrl
        ],
        layout: "StandaloneLayout"
      })
      // End Swagger UI call region

      window.ui = ui
    }

```

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance62

Regular maintenance activity

Popularity1

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity56

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.

###  Release Activity

Cadence

Every ~524 days

Total

5

Last Release

236d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2cb6d4497d6c4358a5c7e7e31d34412f5d6e9617aafa487b125bcc870171cd1e?d=identicon)[fgsl](/maintainers/fgsl)

---

Top Contributors

[![fgsl](https://avatars.githubusercontent.com/u/128915?v=4)](https://github.com/fgsl "fgsl (16 commits)")

---

Tags

documentationswaggergenerator

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/fgsl-swagger-docs/health.svg)

```
[![Health](https://phpackages.com/badges/fgsl-swagger-docs/health.svg)](https://phpackages.com/packages/fgsl-swagger-docs)
```

###  Alternatives

[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

2.9k34.0M112](/packages/darkaonline-l5-swagger)[darkaonline/swagger-lume

OpenApi or Swagger integration to Lumen

3372.3M3](/packages/darkaonline-swagger-lume)[jlapp/swaggervel

A great way to integrate Swagger into Laravel

492931.6k2](/packages/jlapp-swaggervel)

PHPackages © 2026

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