PHPackages                             noitran/opendox - 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. [HTTP & Networking](/categories/http)
4. /
5. noitran/opendox

ActiveLibrary[HTTP & Networking](/categories/http)

noitran/opendox
===============

OpenApi(Swagger) 3.0 package for Lumen 5.5+ and Laravel 5.5+ with REDOC UI and SwaggerUI 3

v1.0.0(4y ago)2313.9k↓50%4[1 issues](https://github.com/noitran/opendox/issues)MITPHPPHP >=7.3CI failing

Since Jan 26Pushed 4y agoCompare

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

READMEChangelog (2)Dependencies (8)Versions (3)Used By (0)

Opendox - OpenAPI 3.0 (Swagger 3) package for Lumen and Laravel
===============================================================

[](#opendox---openapi-30-swagger-3-package-for-lumen-and-laravel)

[![Coverage Status](https://camo.githubusercontent.com/3fddc5f62a4ca54763be094457f48c315937afd26ba9e24faa8fe764036f6c2b/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f636f7665726167652f672f6e6f697472616e2f6f70656e646f782e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/noitran/opendox/code-structure)[![Quality Score](https://camo.githubusercontent.com/798fb00220e5ac185974024b7c61993f67e8d3778bd35f1578b63c4906e07fdb/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6e6f697472616e2f6f70656e646f782e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/noitran/opendox)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![Latest Version](https://camo.githubusercontent.com/02eaaa4c42c60dcda7e272e5a0226fa61a155c3d138f70e8c552280b9850224d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6e6f697472616e2f6f70656e646f782e7376673f7374796c653d666c61742d737175617265)](https://github.com/noitran/opendox/releases)[![Total Downloads](https://camo.githubusercontent.com/ee83e3cee4f55c7d7b69ab939ebd38c554e3bb538f8baa8d7080888162ed2b82/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f696f63617374652f6f70656e646f782e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/iocaste/opendox)

About
-----

[](#about)

This package will add console command to lumen/laravel which will parse yml file, convert it into json and save to public path. Redoc UI is connected and Swagger UI are connected and can be accessed to view generated documentation. Also package adds route for raw json documentation output, so this package can be used in microservice architecture, where all your microservices expose list of available routes.

Features
--------

[](#features)

- Adds console command `php artisan opendox:transform` to transform OpenApi 3.0 specification yaml files to json, so it can be accessible for external services
- Adds `/api/documentation` route where you can access [Redoc UI](https://github.com/Rebilly/ReDoc) interface of documentation
- Adds `/api/console` route where you can access [Swagger UI](https://github.com/swagger-api/swagger-ui) interface for API docs and interaction
- Adds `/docs` route where RAW json can be accessed

Install
-------

[](#install)

- Install as composer package

```
$ composer require noitran/opendox
```

#### Laravel

[](#laravel)

- Laravel uses provider auto discovery. Config file can be published using command

```
$ php artisan vendor:publish --provider="Noitran\Opendox\ServiceProvider"

```

#### Lumen

[](#lumen)

- Open your bootstrap/app.php and register as service provider

```
$app->register(Noitran\Opendox\ServiceProvider::class);
```

- Config file should be loaded manually in bootstrap/app.php

```
$app->configure('opendox');
```

Usage
-----

[](#usage)

- In your application project `/src` folder create `api-docs.yml` file. Write your documentation using [OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md) standard

### Example

[](#example)

```
openapi: "3.0.0"
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
servers:
  - url: http://petstore.swagger.io/v1
paths:
  /pets:
    get:
      summary: List all pets
      operationId: listPets
      tags:
        - pets
      parameters:
        - name: limit
          in: query
          description: How many items to return at one time (max 100)
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: A paged array of pets
          headers:
            x-next:
              description: A link to the next page of responses
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pets"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
components:
  schemas:
    Pet:
      required:
        - id
        - name
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        tag:
          type: string
    Pets:
      type: array
      items:
        $ref: "#/components/schemas/Pet"
    Error:
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string

```

- Transform and publish your configuration file using command

```
$ php artisan opendox:transform
```

- Now your documentation is accessible via specified routes:

```
/api/documentation - Redoc UI interface

/api/console - Swagger UI with ability to send example requests

/docs - Raw JSON documentation output, that can be used for external services

```

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity35

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 90% 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 ~846 days

Total

2

Last Release

1823d ago

Major Versions

v0.1.0 → v1.0.02021-05-21

PHP version history (2 changes)v0.1.0PHP >=7.1

v1.0.0PHP >=7.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/7711b3f7e0b0d6bcc742fc8e27e0d286e50f6d921cdbc24e09fb76a2cf0df4d5?d=identicon)[noitran](/maintainers/noitran)

---

Top Contributors

[![noitran](https://avatars.githubusercontent.com/u/46364989?v=4)](https://github.com/noitran "noitran (9 commits)")[![miladnouri](https://avatars.githubusercontent.com/u/3003901?v=4)](https://github.com/miladnouri "miladnouri (1 commits)")

---

Tags

apilaravelrestdocumentationswaggeropenapilumenswagger-uiredocredoc-ui

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/noitran-opendox/health.svg)

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

###  Alternatives

[api-platform/core

Build a fully-featured hypermedia or GraphQL API in minutes!

2.6k48.1M236](/packages/api-platform-core)[vyuldashev/laravel-openapi

Generate OpenAPI Specification for Laravel Applications

4571.2M](/packages/vyuldashev-laravel-openapi)[darkaonline/swagger-lume

OpenApi or Swagger integration to Lumen

3372.3M3](/packages/darkaonline-swagger-lume)[api-platform/laravel

API Platform support for Laravel

59126.4k6](/packages/api-platform-laravel)[tartanlegrand/laravel-openapi

Generate OpenAPI Specification for Laravel Applications

38178.7k2](/packages/tartanlegrand-laravel-openapi)[vanderlee/swaggergen

Generate Swagger/OpenAPI documentation from simple PHPdoc-like comments in PHP source code.

42127.9k3](/packages/vanderlee-swaggergen)

PHPackages © 2026

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