saro0h/media-api-bundle

Api to upload files.

1.1 2015-10-19 11:20 UTC

Requires

• php: >=5.3.3
• doctrine/doctrine-bundle: ~1.2
• doctrine/orm: ~2.2,>=2.2.3
• jms/serializer-bundle: ~1.0
• sensio/framework-extra-bundle: ~3.0
• symfony/monolog-bundle: ~2.4
• willdurand/hateoas-bundle: 1.0.*@dev

MIT

• Sarah Khalil

• Upload Media Api Bundle

README

This bundle allows you to have an upload of files through an API.

Installation

Step 1: Install MediaApiBundle using Composer

Add MediaApiBundle in your composer.json:

{
    "require": {
        "saro0h/media-api-bundle": "~1.0"
    }
}

Now tell composer to download the bundle by running the command:

$ php composer.phar update saro0h/media-api-bundle

Step 2: Enable the bundle

Enable the bundle in the kernel:

<?php

// app/AppKernel.php
public function registerBundles()
{
    $bundles = array(
        // ...
        new Saro0h\MediaApiBundle\MediaApiBundle(),
        // ...
    );
}

Step 3: Import the routes of the bundle

Add the following lines to the app/config/routing.yml:

media_api_bundle:
    resource: "@MediaApiBundle/Resources/config/routing.yml"

Step 4: Create the database and the schema

Run the following commands (after configuring the ORM parameters)

app/console doctrine:database:create
app/console doctrine:schema:create

Step 4 (optional): Configure your config.yml file

# app/config/config.yml
media_api:
    media_path: %media_path%    # Path to the folder where the media will be uploaded (by default it's `web/uploads` folder of your project)
    field_name: %filename%      # Name of the field used to supply the file in the form (by default it's "media")

Usage

Upload a file

• POST /media

If you did not configure the bundle, you just have to POST on the url /media/api/upload the field mediawith the file as showed below:

If you can also choose the name of the file uploaded by supplying the field filename:

Get a media

• GET /media/api/{id}

Delete a media

• DELETE /media/api/get/{id}

License

This bundle is licensed under the MIT license.