PHPackages io-digital/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. io-digital/opendox ActiveLibrary[HTTP & Networking](/categories/http) io-digital/opendox ================== OpenApi(Swagger) 3.0 package for Laravel 9 with REDOC UI and SwaggerUI 3 1.0(3y ago)11.3kMITPHPPHP ^8.1 Since Dec 6Pushed 3y agoCompare [ Source](https://github.com/io-digital/opendox)[ Packagist](https://packagist.org/packages/io-digital/opendox)[ RSS](/packages/io-digital-opendox/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (1)Dependencies (10)Versions (2)Used By (0) Opendox - OpenAPI 3.0 (Swagger 3) package for Lumen and Laravel =============================================================== [](#opendox---openapi-30-swagger-3-package-for-lumen-and-laravel) [![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE)[![Latest Version](https://camo.githubusercontent.com/7d4560c69364a818a0562b7a491e5fd6cecfd56f3d8fee573c655dc20f66bb91/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f696f2d6469676974616c2f6f70656e646f782e7376673f7374796c653d666c61742d737175617265)](https://github.com/io-digital/opendox/releases)[![Total Downloads](https://camo.githubusercontent.com/a441899e1dac257055e4365c1a8dca6aeea0378ca27e5053665b063da7145bdf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f696f2d6469676974616c2f6f70656e646f782e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/io-digital/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 io-digital/opendox ``` #### Laravel [](#laravel) - Laravel uses provider auto discovery. Config file can be published using command ``` $ php artisan vendor:publish --provider="IoDigital\Opendox\ServiceProvider" ``` #### Lumen [](#lumen) - Open your bootstrap/app.php and register as service provider ``` $app->register(IoDigital\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 29 — LowBetter than 59% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity21 Limited adoption so far Community9 Small or concentrated contributor base Maturity54 Maturing project, gaining track record Bus Factor1 Top contributor holds 81.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 Unknown Total 1 Last Release 1259d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/0acb24b4d76853e47a3ad42fba61d9c623a7e0ea4d38e52ac134dd953174529b?d=identicon)[io-digital](/maintainers/io-digital) --- Top Contributors [![noitran](https://avatars.githubusercontent.com/u/46364989?v=4)](https://github.com/noitran "noitran (9 commits)")[![garethnic](https://avatars.githubusercontent.com/u/1523598?v=4)](https://github.com/garethnic "garethnic (1 commits)")[![miladnouri](https://avatars.githubusercontent.com/u/3003901?v=4)](https://github.com/miladnouri "miladnouri (1 commits)") --- Tags apilaravelrestdocumentationswaggeropenapilumenswagger-uiredocredoc-ui ### Code Quality TestsPHPUnit Static AnalysisPsalm Type Coverage Yes ### Embed Badge ![Health badge](/badges/io-digital-opendox/health.svg) ``` [![Health](https://phpackages.com/badges/io-digital-opendox/health.svg)](https://phpackages.com/packages/io-digital-opendox) ``` ### Alternatives [noitran/opendox OpenApi(Swagger) 3.0 package for Lumen 5.5+ and Laravel 5.5+ with REDOC UI and SwaggerUI 3 2313.9k](/packages/noitran-opendox)[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) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)