Adding a text file

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsAdding a text file
Line 1: Line 1:
### Tutorial
+
=== Tutorial ===
  
 
DreamFactory 2.0 allows you to expose various storage services as API Endpoints. The following storage services are currently  
 
DreamFactory 2.0 allows you to expose various storage services as API Endpoints. The following storage services are currently  
Line 10: Line 10:
 
* Rackspace Cloud Files
 
* Rackspace Cloud Files
  
### Provisioning a Storage Service
+
=== Provisioning a Storage Service ===
  
 
All DreamFactory 2.0 instances come pre-configured with a 'Local Storage' service named 'files'. You can find this service  
 
All DreamFactory 2.0 instances come pre-configured with a 'Local Storage' service named 'files'. You can find this service  
Line 21: Line 21:
 
storage service - 'files'.
 
storage service - 'files'.
  
### API Endpoints
+
=== API Endpoints ===
  
 
In these examples, when using the API to create a file the destination folder is part of the URL and must have a trailing slash. The slash is what indicates it's a folder.
 
In these examples, when using the API to create a file the destination folder is part of the URL and must have a trailing slash. The slash is what indicates it's a folder.
Line 39: Line 39:
 
</source>
 
</source>
  
### Example  
+
=== Example ===
  
 
* Storage service: files
 
* Storage service: files

Revision as of 18:01, 3 February 2016

Tutorial

DreamFactory 2.0 allows you to expose various storage services as API Endpoints. The following storage services are currently supported.

  • Local Storage (configurable to use local file system, S3, Azure, or Rackspace)
  • AWS S3
  • Azure Blob
  • OpenStack Object Storage
  • Rackspace Cloud Files

Provisioning a Storage Service

All DreamFactory 2.0 instances come pre-configured with a 'Local Storage' service named 'files'. You can find this service on the admin console, under the services tab. You can also provision as many other storage services as you like using the admin console. Login to the admin console and select the 'Services' tab. Click on the 'Create' button from the left menu. On the service creation form select your storage type from the 'Service Type' drop down box (File section). Enter a short, one-word, meaningful name for your service as well as a label and description. Depending on which storage type you pick, you will need to enter the service configuration values on the 'Config' tab. Create your storage service after entering all your configuration values. Your storage service is now ready for action. For this tutorial, we will use the pre-configured storage service - 'files'.

API Endpoints

In these examples, when using the API to create a file the destination folder is part of the URL and must have a trailing slash. The slash is what indicates it's a folder.

POST http://{url}/api/v2/{storage_service_name}/{folder}/

Request Body:

{
    "resource":[
        {
            "name":"{file}",
            "type":"file",
            "content":"{content}"
        }
    ]
}

Example

  • Storage service: files
  • Folder: docs
  • File: hello.txt
  • Content: Hello World!
  • Request Body:
{
    "resource":[
        {
            "name":"hello.txt",
            "type":"file",
            "content":"Hello World!"
        }
    ]
}
  • Request URL has trailing slash because docs is a folder:
POST http://foo.com/api/v2/files/docs/