Download the PHP package nahid-ferdous/laravel-module-generator without Composer

Laravel Module Generator

A developer-friendly Laravel package to generate complete modules (Model, Migration, Controller, Service, Resource, Collection, Form Request, and Routes) from a single YAML configuration file. Now includes Postman collection generation and DB diagram export for streamlined API development and documentation.

✨ Features

• Generate full Laravel modules from YAML configuration
• Customizable stub support (with fallback to internal defaults)
• 🆕 Postman collection generation for instant API testing
• 🆕 Database diagram export compatible with dbdiagram.io
• Generates:
  • Models with relationships
  • Database migrations
  • API Controllers
  • Service classes
  • Form Request validation
  • API Resources & Collections
  • Route entries
  • Postman collection files
  • DB diagram files (.dbml)
• Smart fillable and relationship handling
• Designed for rapid development and prototyping

🚀 Installation

Install the package via Composer:

📦 Service Provider

Generate required files and configurations:

📂 Optional: Publish Config & Stubs

You may publish the configuration and stub files to customize them. If you don't publish them, the package will use its built-in defaults automatically.

This will publish:

• Config: config/module-generator.php
• Stubs: module/stub/

🛠️ Usage

1. Create Your YAML Configuration

Create a YAML file at the default path: module/models.yaml

Define your models with their fields, validation rules, and relationships:

Example: module/models.yaml

2. Generate Your Complete Module

Generate the complete module structure with all features:

Available Options:

3. Generate Individual Components

You can also generate specific components separately:

Generate Postman Collection Only

Generate DB Diagram Only

Backup Existing Files While Generating

🧪 What Gets Generated

For each model defined in your YAML file, the package will generate:

Core Laravel Components

• ✅ Eloquent Model → app/Models/
• ✅ Migration → database/migrations/
• ✅ API Controller → app/Http/Controllers/
• ✅ Service Class → app/Services/
• ✅ Form Request → app/Http/Requests/
• ✅ API Resource → app/Http/Resources/
• ✅ Resource Collection → app/Http/Resources/
• ✅ Route Registration → routes/api.php

🆕 Documentation & Testing

• ✅ Postman Collection → module/postman_collection.json
• ✅ DB Diagram → module/dbdiagram.dbml

📋 Postman Collection Features

The generated Postman collection includes:

• Complete CRUD operations for each model
• Proper HTTP methods (GET, POST, PUT, DELETE)
• Request examples with sample data
• Environment variables for base URL and API prefix
• Organized folder structure by model
• Authentication placeholders

Sample generated endpoints:

🗄️ Database Diagram Features

The generated DB diagram (.dbml) includes:

• Complete table definitions with all columns
• Relationship mappings (foreign keys, indexes)
• Data types and constraints
• Compatible with dbdiagram.io for visualization
• Exportable to various formats (PNG, PDF, SQL)

Usage with dbdiagram.io:

1. Copy the content from module/dbdiagram.dbml
2. Visit dbdiagram.io
3. Paste the content to visualize your database schema
4. Export as needed (PNG, PDF, SQL)

🧱 Stub Customization

This package allows you to override any of the stubs it uses for complete customization of generated code.

Default Stub Configuration

Customizing Stubs

If you published the stubs with:

You can edit them at: module/stub/

Each stub file uses placeholders that get replaced during generation, allowing you to maintain consistency across your entire codebase.

⚙️ Configuration

To change the YAML path or customize stub names, update config/module-generator.php:

📝 YAML Schema Guide

Field Types

• string - VARCHAR field
• string:unique - VARCHAR with unique constraint
• string:nullable - Nullable VARCHAR
• boolean:default true - Boolean with default value
• foreignId:table_name - Foreign key reference
• double - Double/float field

Relationship Types

• belongsTo - Belongs to relationship
• hasMany - Has many relationship
• hasOne - Has one relationship
• belongsToMany - Many-to-many relationship

Unique Constraints

Define composite unique constraints:

Selective Generation

Control what gets generated for each model:

🚀 Complete Workflow Example

Here's a complete workflow from YAML to production-ready API:

🔄 Versioning

This package follows Semantic Versioning. Use tags like v1.0.0, v1.1.0, etc., when pushing updates to Packagist.

🤝 Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This package is open-sourced software licensed under the MIT license.

🙏 Credits

Created and maintained by Nahid Ferdous

Special thanks to the Laravel community and all contributors who help improve this package.

🐛 Issues & Support

If you encounter any issues or have questions:

1. Check the existing issues
2. Create a new issue with detailed information
3. Include your YAML configuration and error messages

🚀 Roadmap

• [x] Postman collection generation
• [x] Database diagram export
• [ ] Support for additional relationship types
• [ ] GUI for YAML configuration
• [ ] Integration with Laravel Sanctum
• [ ] Custom validation rule generation
• [ ] Support for nested resources
• [ ] OpenAPI/Swagger documentation generation
• [ ] Insomnia collection export
• [ ] GraphQL schema generation

📈 Recent Updates

v1.0.10

• ✅ NEW: Postman collection generation
• ✅ NEW: Database diagram export (dbdiagram.io compatible)
• ✅ NEW: Selective component generation
• ✅ IMPROVED: Enhanced command options and flexibility
• ✅ IMPROVED: Better error handling and user feedback

Happy coding! 🎉