Skip to content

vgratsilev/symfony-rest-api

Repository files navigation

REST API via Symfony

Works with /data directory in server root.

Functions:

  • Create file

Description

Create file from request content

URL Structure
<root>/files/<fileName>

fileName The name of your file

Method

POST

Returns

201 File created

Errors

409 The file already exist or writing error

  • Update file

Description

Update file with request content

URL Structure
<root>/files/<fileName>

fileName The name of your file

Parameter

Append Allows appending to file (true/false)

Method

PUT

Returns

200 File updated

Errors
  • 404 The file wasn't found

  • 409 Writing error

  • Get file

Description

Downloads a file.

URL Structure
<root>/files/<fileName>

fileName The name of your file

Method

GET

Returns

The specified file's contents

Errors

404 The file wasn't found

  • Get file metadata

Description

Return file's metadata

URL Structure
<root>/files/<fileName>/meta

fileName The name of your file

Method

GET

Returns

The JSON metadata for the file by the given Return value definitions

  • name - the file name
  • extension - the file extension
  • size - the file size in bytes
  • type - the file type
Errors

404 The file wasn't found

  • Get list of files

Description

Return list of files in /data directory

URL Structure
<root>/files
Method

GET

Returns

The JSON list of files in /data directory

Additional features, that should be, but don't

  • Storage files in compressed form through ZipArchive.
  • Using validator for file limitation: max size, type, etc. Probably via VichUploaderBundle or IphpFileStoreBundle.
  • Using https instead of http and authorizing mechanism. Realization via configuration security.yml.
  • Access restriction to the file with adding additional information about file owner in file-model.

About

HTTP REST API via Symfony (obsolete)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published