Storage component for LoopBack.
Go to file
Miroslav Bajtoš 4ea51fcd8c Mark HTTP path parameters as required
Per Swagger spec 2.0, parameters coming from the path must be marked
as required.

Before this change, the Swagger spec produced by loopback-swagger
was not valid because path parameters were optional.

Note that this commit does not fix the problem of the "uploaded"
method which does not have any swagger-supported parameters now,
and therefore the swagger spec will remain invalid (but with less
errors).
2018-01-06 22:46:26 -03:00
.github Add stalebot configuration 2018-01-06 22:46:26 -03:00
intl Update translated strings Q3 2017 2018-01-06 22:43:04 -03:00
lib Mark HTTP path parameters as required 2018-01-06 22:46:26 -03:00
test Update deps 2018-01-06 22:42:59 -03:00
.eslintignore Fix eslint 2018-01-06 22:28:42 -03:00
.eslintrc Fix linting errors 2016-10-19 11:36:39 -04:00
.gitignore Add translated files 2016-09-22 15:10:38 -04:00
.travis.yml add .travis.yml 2018-01-06 22:43:04 -03:00
CHANGES.md 3.2.0 2018-01-06 22:43:04 -03:00
CODEOWNERS Add CODEOWNER file 2018-01-06 22:43:04 -03:00
CONTRIBUTING.md Update URLs in CONTRIBUTING.md (#138) 2016-07-13 17:54:14 -07:00
LICENSE.md relicese as Artistic-2.0 only 2016-05-03 16:16:43 -07:00
README.md Explain new functionality in README 2018-01-06 22:44:37 -03:00
docs.json Update docs.json 2014-04-10 11:40:26 -07:00
index.js Fix linting errors 2016-10-19 11:36:39 -04:00
package.json Update dependencies 2018-01-06 22:43:23 -03:00

README.md

LoopBack Storage Component

NOTE: The loopback-component-storage module supersedes loopback-storage-service. Please update your package.json accordingly.

LoopBack storage component provides Node.js and REST APIs to manage binary contents using pluggable storage providers, such as local file systems, Amazon S3, or Rackspace cloud files. We use pkgcloud to support the cloud based storage services including:

  • Amazon
  • Rackspace
  • Openstack
  • Azure

Please see the Storage Service Documentaion.

For more details on the architecture of the module, please see the introduction section of the blog post written up its launch.

Use

Now you can use Container's name with slash! If you want to create a directory, like this/isMy/newContainer, you have to use the char %2F instead of /, so your Container's name going to be this%2FisMy%2FnewContainer.

URL Example

Syntax

[POST] <<YOUR_URL>>:<<YOUR_PORT>>/api/Containers/<<CONTAINER_NAME>>/
[POST] <<YOUR_URL>>:<<YOUR_PORT>>/api/Containers/<<CONTAINER_NAME>>/upload (For upload file)

Example

[POST] http://example.com:3000/api/Containers/images%2Fprofile%2Fpersonal/
[POST] http://example.com:3000/api/Containers/images%2Fprofile%2Fpersonal/upload (For upload file)

Add option to your dataSources.json

If you want a default name only for the upload images (not files), you have to add defaultImageName to your Container options. datasources.json

[...]
  "container": {
    "name": "container",
    "connector": "loopback-component-storage",
    "provider": "filesystem",
    "maxFileSize": "10485760",
    "root": "./storage",
    "defaultImageName": "photo"
  }
[...]

Examples

See https://github.com/strongloop/loopback-example-storage.