PHPackages                             esandri/swagger-ui-big - 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. esandri/swagger-ui-big

ActiveLibrary[API Development](/categories/api)

esandri/swagger-ui-big
======================

 Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

v3.20.4(7y ago)073Apache-2.0JavaScript

Since Aug 24Pushed 7y ago1 watchersCompare

[ Source](https://github.com/esandri/swagger-ui)[ Packagist](https://packagist.org/packages/esandri/swagger-ui-big)[ Docs](http://swagger.io)[ RSS](/packages/esandri-swagger-ui-big/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (120)Used By (0)

You are probably in the wrong project. The main project is [swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui)In this branch I changed the `sampleFromSchema` to skip references in samples generated from the models eg

```
"components": {
  "schemas": {
    "Group": {
      "description": "Group of users",
      "properties": {
        "group_id": {
          "type": "string",
          "description": "unique identifier of the group"
        },
        "name": {
          "type": "string",
          "description": "the name of the group"
        },
        "users": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/User"
          }
        }
      }
    },
    "User": {
      "description": "A user",
      "properties": {
        "user_id": {
          "type": "string",
          "description": "unique identifier of the user"
        },
        "name": {
          "type": "string",
          "description": "the name of the user"
        },
        "group": {
          "$ref": "#/components/schemas/Group"
        }
      }
    }
  }
}
```

will generate the following example in responses or in request body section for group:

```
{
  "group_id": "string",
  "name": "string",
}
```

for user:

```
{
  "user_id": "string",
  "name": "string",
}
```

this is useful when you are working on very complex domains

[![](https://raw.githubusercontent.com/swagger-api/swagger.io/wordpress/images/assets/SWU-logo-clr.png)](https://raw.githubusercontent.com/swagger-api/swagger.io/wordpress/images/assets/SWU-logo-clr.png)
===========================================================================================================================================================================================================

[](#)

[![NPM version](https://camo.githubusercontent.com/cfe28814e1caf20cbfa822bdd725f8ba712d06c6fb0255158ef957e1a85d0300/68747470733a2f2f62616467652e667572792e696f2f6a732f737761676765722d75692e737667)](http://badge.fury.io/js/swagger-ui)

**👉🏼 Want to score an easy open-source contribution?** Check out our [Good first issue](https://github.com/swagger-api/swagger-ui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%22) label.

**🕰️ Looking for the older version of Swagger UI?** Refer to the [*2.x* branch](https://github.com/swagger-api/swagger-ui/tree/2.x).

This repository publishes to two different NPM modules:

- [swagger-ui](https://www.npmjs.com/package/swagger-ui) is a traditional npm module intended for use in single-page applications that are capable of resolving dependencies (via Webpack, Browserify, etc).
- [swagger-ui-dist](https://www.npmjs.com/package/swagger-ui-dist) is a dependency-free module that includes everything you need to serve Swagger UI in a server-side project, or a single-page application that can't resolve npm module dependencies.

We strongly suggest that you use `swagger-ui` instead of `swagger-ui-dist` if you're building a single-page application, since `swagger-ui-dist` is significantly larger.

Compatibility
-------------

[](#compatibility)

The OpenAPI Specification has undergone 5 revisions since initial creation in 2010. Compatibility between Swagger UI and the OpenAPI Specification is as follows:

Swagger UI VersionRelease DateOpenAPI Spec compatibilityNotes3.18.32018-08-032.0, 3.0[tag v3.18.3](https://github.com/swagger-api/swagger-ui/tree/v3.18.3)3.0.212017-07-262.0[tag v3.0.21](https://github.com/swagger-api/swagger-ui/tree/v3.0.21)2.2.102017-01-041.1, 1.2, 2.0[tag v2.2.10](https://github.com/swagger-api/swagger-ui/tree/v2.2.10)2.1.52016-07-201.1, 1.2, 2.0[tag v2.1.5](https://github.com/swagger-api/swagger-ui/tree/v2.1.5)2.0.242014-09-121.1, 1.2[tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24)1.0.132013-03-081.1, 1.2[tag v1.0.13](https://github.com/swagger-api/swagger-ui/tree/v1.0.13)1.0.12011-10-111.0, 1.1[tag v1.0.1](https://github.com/swagger-api/swagger-ui/tree/v1.0.1)Documentation
-------------

[](#documentation)

#### Usage

[](#usage)

- [Installation](docs/usage/installation.md)
- [Configuration](docs/usage/configuration.md)
- [CORS](docs/usage/cors.md)
- [OAuth2](docs/usage/oauth2.md)
- [Deep Linking](docs/usage/deep-linking.md)
- [Limitations](docs/usage/limitations.md)
- [Version detection](docs/usage/version-detection.md)

#### Customization

[](#customization)

- [Overview](docs/customization/overview.md)
- [Plugin API](docs/customization/plugin-api.md)
- [Custom layout](docs/customization/custom-layout.md)

#### Development

[](#development)

- [Setting up](docs/development/setting-up.md)
- [Scripts](docs/development/scripts.md)

##### Integration Tests

[](#integration-tests)

You will need JDK of version 7 or higher as instructed here

Integration tests can be run locally with `npm run e2e` - be sure you aren't running a dev server when testing!

### Browser support

[](#browser-support)

Swagger UI works in the latest versions of Chrome, Safari, Firefox, Edge and IE11.

### Known Issues

[](#known-issues)

To help with the migration, here are the currently known issues with 3.X. This list will update regularly, and will not include features that were not implemented in previous versions.

- Only part of the parameters previously supported are available.
- The JSON Form Editor is not implemented.
- Support for `collectionFormat` is partial.
- l10n (translations) is not implemented.
- Relative path support for external files is not implemented.

Security contact
----------------

[](#security-contact)

Please disclose any security-related issues or vulnerabilities by emailing , instead of using the public issue tracker.

License
-------

[](#license)

Copyright 2019 SmartBear Software

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

###  Health Score

35

—

LowBetter than 80% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity80

Battle-tested with a long release history

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~9 days

Total

95

Last Release

2695d ago

Major Versions

v2.2.10 → v3.0.52017-04-08

2.x-dev → v3.0.132017-06-03

### Community

Maintainers

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

---

Top Contributors

[![shockey](https://avatars.githubusercontent.com/u/680248?v=4)](https://github.com/shockey "shockey (1256 commits)")[![fehguy](https://avatars.githubusercontent.com/u/249413?v=4)](https://github.com/fehguy "fehguy (1028 commits)")[![bodnia](https://avatars.githubusercontent.com/u/8950657?v=4)](https://github.com/bodnia "bodnia (283 commits)")[![owenconti](https://avatars.githubusercontent.com/u/791222?v=4)](https://github.com/owenconti "owenconti (156 commits)")[![mohsen1](https://avatars.githubusercontent.com/u/543633?v=4)](https://github.com/mohsen1 "mohsen1 (122 commits)")[![webron](https://avatars.githubusercontent.com/u/241629?v=4)](https://github.com/webron "webron (78 commits)")[![ponelat](https://avatars.githubusercontent.com/u/8438485?v=4)](https://github.com/ponelat "ponelat (64 commits)")[![heldersepu](https://avatars.githubusercontent.com/u/545474?v=4)](https://github.com/heldersepu "heldersepu (59 commits)")[![ayush](https://avatars.githubusercontent.com/u/188701?v=4)](https://github.com/ayush "ayush (57 commits)")[![Minasokoni](https://avatars.githubusercontent.com/u/1010168?v=4)](https://github.com/Minasokoni "Minasokoni (35 commits)")[![thompsongl](https://avatars.githubusercontent.com/u/2728212?v=4)](https://github.com/thompsongl "thompsongl (34 commits)")[![zeke](https://avatars.githubusercontent.com/u/2289?v=4)](https://github.com/zeke "zeke (32 commits)")[![lepinayl](https://avatars.githubusercontent.com/u/11438384?v=4)](https://github.com/lepinayl "lepinayl (30 commits)")[![RVKen](https://avatars.githubusercontent.com/u/29341532?v=4)](https://github.com/RVKen "RVKen (12 commits)")[![swaggerhub-bot](https://avatars.githubusercontent.com/u/14862288?v=4)](https://github.com/swaggerhub-bot "swaggerhub-bot (11 commits)")[![pose](https://avatars.githubusercontent.com/u/419703?v=4)](https://github.com/pose "pose (10 commits)")[![rpidikiti](https://avatars.githubusercontent.com/u/684178?v=4)](https://github.com/rpidikiti "rpidikiti (9 commits)")[![symonenkov](https://avatars.githubusercontent.com/u/15044954?v=4)](https://github.com/symonenkov "symonenkov (8 commits)")[![scottohara](https://avatars.githubusercontent.com/u/289327?v=4)](https://github.com/scottohara "scottohara (7 commits)")[![Eke](https://avatars.githubusercontent.com/u/817489?v=4)](https://github.com/Eke "Eke (7 commits)")

---

Tags

apidocumentationuispecificationswaggeropenapi

### Embed Badge

![Health badge](/badges/esandri-swagger-ui-big/health.svg)

```
[![Health](https://phpackages.com/badges/esandri-swagger-ui-big/health.svg)](https://phpackages.com/packages/esandri-swagger-ui-big)
```

###  Alternatives

[swagger-api/swagger-ui

 Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

28.7k45.4M99](/packages/swagger-api-swagger-ui)[darkaonline/l5-swagger

OpenApi or Swagger integration to Laravel

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

OpenApi or Swagger integration to Lumen

3372.3M3](/packages/darkaonline-swagger-lume)

PHPackages © 2026

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