Git Product home page Git Product logo

symfony-rest-api's Introduction

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.

symfony-rest-api's People

Contributors

vgratsilev avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.