{"id":28316197,"url":"https://github.com/tomo3076/php-crud-api-generator","last_synced_at":"2025-06-23T19:30:35.482Z","repository":{"id":294862412,"uuid":"988246197","full_name":"tomo3076/PHP-CRUD-API-Generator","owner":"tomo3076","description":"PHP CRUD API Generator allows you to quickly turn your MySQL/MariaDB database into a REST-like API with ease. 🚀 With features like auto-discovery of tables and robust authentication options, it simplifies backend development while ensuring security. 💻","archived":false,"fork":false,"pushed_at":"2025-06-20T01:45:20.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-20T02:33:15.605Z","etag":null,"topics":["api-generator","maraidb-api","maria-database-api","mariadb","mysql","mysql-api","php","php-api","php-api-generator","phpapi","phpcrudapi"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tomo3076.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-22T09:10:57.000Z","updated_at":"2025-06-20T01:45:23.000Z","dependencies_parsed_at":"2025-06-05T17:25:45.762Z","dependency_job_id":"49ab8222-6469-4119-8936-6be848907753","html_url":"https://github.com/tomo3076/PHP-CRUD-API-Generator","commit_stats":null,"previous_names":["tomo3076/php-crud-api-generator"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tomo3076/PHP-CRUD-API-Generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomo3076%2FPHP-CRUD-API-Generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomo3076%2FPHP-CRUD-API-Generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomo3076%2FPHP-CRUD-API-Generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomo3076%2FPHP-CRUD-API-Generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tomo3076","download_url":"https://codeload.github.com/tomo3076/PHP-CRUD-API-Generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tomo3076%2FPHP-CRUD-API-Generator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261542550,"owners_count":23174600,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-generator","maraidb-api","maria-database-api","mariadb","mysql","mysql-api","php","php-api","php-api-generator","phpapi","phpcrudapi"],"created_at":"2025-05-25T02:08:06.509Z","updated_at":"2025-06-23T19:30:35.470Z","avatar_url":"https://github.com/tomo3076.png","language":"PHP","readme":"# PHP CRUD API Generator 🚀\n\n![PHP CRUD API Generator](https://img.shields.io/badge/version-1.0.0-blue.svg)\n![License](https://img.shields.io/badge/license-MIT-green.svg)\n![GitHub stars](https://img.shields.io/github/stars/tomo3076/PHP-CRUD-API-Generator.svg?style=social)\n\nWelcome to the **PHP CRUD API Generator** repository! This tool helps you quickly create a fully functional API for your MariaDB or MySQL database using PHP. Whether you are a developer looking to streamline your API development or a beginner eager to learn, this project provides a simple and effective solution.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [API Endpoints](#api-endpoints)\n- [Configuration](#configuration)\n- [Contributing](#contributing)\n- [License](#license)\n- [Support](#support)\n\n## Features\n\n- **Easy Setup**: Quickly generate APIs with minimal configuration.\n- **Supports MariaDB and MySQL**: Work with the databases you know.\n- **RESTful API**: Follow REST principles for easy integration.\n- **Customizable**: Modify generated code to suit your needs.\n- **Lightweight**: Designed to be efficient and fast.\n\n## Installation\n\nTo get started, download the latest release from the [Releases section](https://github.com/tomo3076/PHP-CRUD-API-Generator/releases). After downloading, extract the files to your server directory.\n\n### Prerequisites\n\n- PHP 7.2 or higher\n- MariaDB or MySQL\n- Composer (for dependency management)\n\n### Steps\n\n1. **Clone the Repository**:\n   ```bash\n   git clone https://github.com/tomo3076/PHP-CRUD-API-Generator.git\n   ```\n\n2. **Navigate to the Directory**:\n   ```bash\n   cd PHP-CRUD-API-Generator\n   ```\n\n3. **Install Dependencies**:\n   ```bash\n   composer install\n   ```\n\n4. **Configure Your Database**: Open the `config.php` file and set your database credentials.\n\n5. **Run the Application**: Access the API through your web server.\n\n## Usage\n\nOnce you have installed the API generator, you can start creating your endpoints. Here’s how to use the tool effectively:\n\n1. **Define Your Database Structure**: Create tables in your MariaDB or MySQL database.\n2. **Generate the API**: Use the command line to generate your API endpoints.\n   ```bash\n   php generate.php\n   ```\n3. **Test Your API**: Use tools like Postman or curl to test the endpoints.\n\n## API Endpoints\n\nThe API supports various endpoints for CRUD operations:\n\n- **Create**: POST request to create a new record.\n- **Read**: GET request to retrieve records.\n- **Update**: PUT request to update an existing record.\n- **Delete**: DELETE request to remove a record.\n\n### Example Requests\n\n- **Create a Record**:\n   ```bash\n   curl -X POST -H \"Content-Type: application/json\" -d '{\"name\": \"John Doe\"}' http://yourapi.com/api/users\n   ```\n\n- **Read Records**:\n   ```bash\n   curl -X GET http://yourapi.com/api/users\n   ```\n\n- **Update a Record**:\n   ```bash\n   curl -X PUT -H \"Content-Type: application/json\" -d '{\"name\": \"Jane Doe\"}' http://yourapi.com/api/users/1\n   ```\n\n- **Delete a Record**:\n   ```bash\n   curl -X DELETE http://yourapi.com/api/users/1\n   ```\n\n## Configuration\n\nTo configure your API, modify the `config.php` file. You will need to set the following parameters:\n\n- **Database Host**: Your database server address.\n- **Database Name**: The name of your database.\n- **Database User**: Your database username.\n- **Database Password**: Your database password.\n\n### Example Configuration\n\n```php\ndefine('DB_HOST', 'localhost');\ndefine('DB_NAME', 'your_database');\ndefine('DB_USER', 'your_username');\ndefine('DB_PASS', 'your_password');\n```\n\n## Contributing\n\nWe welcome contributions! If you would like to help improve the PHP CRUD API Generator, please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature/YourFeature`).\n3. Make your changes.\n4. Commit your changes (`git commit -m 'Add some feature'`).\n5. Push to the branch (`git push origin feature/YourFeature`).\n6. Open a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Support\n\nIf you have any questions or need support, please check the [Releases section](https://github.com/tomo3076/PHP-CRUD-API-Generator/releases) for updates. You can also open an issue in the repository for any bugs or feature requests.\n\n---\n\nThank you for using the PHP CRUD API Generator! We hope this tool makes your API development process easier and more efficient. Happy coding!","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomo3076%2Fphp-crud-api-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftomo3076%2Fphp-crud-api-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftomo3076%2Fphp-crud-api-generator/lists"}