Opendox

Overview

Opendox is an innovative package designed for developers using Lumen and Laravel frameworks. It simplifies the process of generating API documentation by transforming YAML files into JSON format, making documentation easier to manage and access. With the integration of both Redoc and Swagger UI, Opendox provides a comprehensive solution for visualizing API endpoints, making it ideal for projects using microservice architecture.

This package not only enhances the developer experience but also ensures that API documentation is always up-to-date and readily accessible. This means that teams can focus more on development without worrying about keeping their documentation in sync with their APIs.

Features

• Console Command: Adds the php artisan opendox:transform command to transform OpenAPI 3.0 specification YAML files into JSON, seamlessly making them accessible for external services.

• Redoc UI Integration: Provides an /api/documentation route that allows you to access the Redoc UI interface for an organized and visually appealing documentation experience.

• Swagger UI Access: Offers a /api/console route to access the Swagger UI for API documentation and interaction, facilitating easier testing of API calls and understanding of available endpoints.

• Raw JSON Output: Includes a /docs route where you can access the raw JSON output of your API documentation, making it suitable for any service that requires direct integration with your API specs.

• Easy Installation: Simple installation process via Composer for Laravel, with auto-discovery of providers, and manual registration for Lumen, ensuring easy integration into your existing projects.

Overall, Opendox is a powerful tool for any developer looking to streamline API documentation processes while ensuring that they remain compliant with the OpenAPI standard.