Legalcdn API documentation version v1

https://legalcdn.com/api/v1

Описание

  • Ссылка на спецификацию RAML: https://raml.org/developers/raml-200-tutorial

  • Консольная команда для генерации документации приложения:

    php bin/console documentation:generate v1

  • Документация храниться в папке docs/api/{version} - корня проекта

    • dist папка содержит сформированный документ - index.html
    • src документация для роутов/модулей (пример files)
    • api.raml основной файл, объеденяющий всю файлы raml в один

  • Коллекция для postman - docs/postman_collection.json

  • Дополнительная информация:

    • В облаке созданы две рабочии папки :
      • web: для хранения асетов - js, css, файлов верстки, картинок, загружаются во время деплоя
      • static: для хранения загружаемых пользователями файлов
    • При успешной загрузке в ответе можно наблюдать неявный путь к файлу, именно префикс /cdn/, это вирутальный путь, для понимания проектом что файл именно с legalcdn.
      "path": "/cdn/static/00/00/5d413163c510c_1564553571.jpg"
      При работе с файлом, к примеру получение информации info/{path}, удалении delete/{path}, этот префикс необходимо убирать - static/00/00/5d413163c510c_1564553571.jpg, web/a/b/c.js

  • Консольные команды приложения:

    #создание миграции
php bin/console doctrine:migrations:generate
#выполнение указанной миграции
php bin/console doctrine:migrations:execute --up timestamp
#откат указанной миграции
php bin/console doctrine:migrations:execute --down timestamp
#выполнение всех миграций
php bin/console doctrine:migrations:migrate --no-interaction

#очистка кэша
php bin/console cache:clear

#удаление указанно папки из digital ocean
php bin/console files:remove static legalbet

#синхронизация с резервным хранилищем
php bin/console files:sync legalbet

#создание копии файлов в формате webp
php bin/console files:webp legalbet

#удаление файлов по окружению
php bin/console files:remove-by-env dev

#генерация токена авторизации
php bin/console auth:token:generate project::legalbet key1::value1 key2::value2
допустимые опции :
    - secret
    - algo
    - expired
#помещает задачу в трубу 
php bin/console queue:beanstalkd:test 'legalcdn.command' id::10 name::cacos

  • Воркеры приложения:

    #обработка изображений, оптимизация
php bin/console queue:beanstalkd:run --action='legalcdn.image'

#синхронизация файлов с резервным хранилищем
php bin/console queue:beanstalkd:run --action='legalcdn.sync'

/upload

Загрузка

post

post

Загрузка файлов

Загрузка файлов

Secured by Bearer

Body

Media type: application/x-www-form-urlencoded

Type: any

Example:

{
  "formParameters": {
    "file": {
      "description": "Файл для загрузки",
      "type": [
        "array",
        "file"
      ],
      "example": "example.jpg",
      "required": true
    },
    "name": {
      "description": "Название файла (доступен только при доверенной стратегии - trusted)",
      "type": [
        "string",
        "array"
      ],
      "example": "example-name.jpg",
      "required": false
    },
    "path": {
      "description": "Путь до файла (доступен только при доверенной стратегии - trusted)",
      "type": "string",
      "example": "/static/01/02/",
      "required": false
    },
    "img_link": {
      "description": "Ссылки на ресурс (можно передавать через запятую)",
      "type": "string",
      "example": "http://example/file.jpg | http://example/file.jpg,http://example2/file.jpg",
      "required": false
    }
  }
}

HTTP status code 201

Body

Media type: application/json

Type: any

Example:

{
  "success": [
    {
      "id": "146",
      "url": "https://testweb.fra1.digitaloceanspaces.com/cdn/static/00/00/5d413163c510c_1564553571.jpg",
      "path": "/cdn/static/00/00/5d413163c510c_1564553571.jpg",
      "width": 898,
      "height": 624,
      "ratio": 1.4391025641025641,
      "thumbs": [
        {
          "id": "147",
          "url": "https://testweb.fra1.digitaloceanspaces.com/cdn/static/00/00/thumb6_5d413163c510c_1564553571.jpg",
          "path": "/cdn/static/00/00/thumb6_5d413163c510c_1564553571.jpg",
          "width": 575,
          "height": 400,
          "ratio": 1.4375
        },
        {
          "id": "148",
          "url": "https://testweb.fra1.digitaloceanspaces.com/cdn/static/00/00/tmp6_5d413163c510c_1564553571.jpg",
          "path": "/cdn/static/00/00/tmp6_5d413163c510c_1564553571.jpg",
          "width": 48,
          "height": 34,
          "ratio": 1.411764705882353
        }
      ]
    }
  ],
  "failure": [
    "Minimal image size: 10px"
  ],
  "memory": {
    "usage": 20,
    "peak": 20,
    "profiler": 20
  }
}

Secured by Bearer

Headers

  • Authorization: required(string)

    Авторизация по токену

    Example:

    Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwcm9qZWN0IjoibGVnYWxiZXQiLCJzdHJhdGVneSI6ImNvbW1lbnQiLCJlbnYiOiJkZXYiLCJpYXQiOjE1NjQxMjQwMTAsIm5iZiI6MTU2NDEyNDAxMCwiZXhwIjoxNTY0OTg4MDEwfQ.jz7W86FeDt49G48w_0rStlCvl1Tl90zWURhDBxpmItk

HTTP status code 403

Доступ к API запрещен

/info

Информация

get

token может быть идентификатором файла, или путем до файла

get

Информация о файле

Информация о файле

Secured by Bearer

URI Parameters

  • token: required(string | integer)

    Example:

    /1 | /path/to/file/example.jpg

HTTP status code 201

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "738",
    "url": "https://testweb.fra1.digitaloceanspaces.com/cdn/static/00/00/5d5b8c3f85818_1566280767.jpg",
    "path": "/cdn/static/00/00/5d5b8c3f85818_1566280767.jpg",
    "width": 898,
    "height": 624,
    "ratio": 1.4391025641025641
  }
]

HTTP status code 404

File not found.

Secured by Bearer

Headers

  • Authorization: required(string)

    Авторизация по токену

    Example:

    Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwcm9qZWN0IjoibGVnYWxiZXQiLCJzdHJhdGVneSI6ImNvbW1lbnQiLCJlbnYiOiJkZXYiLCJpYXQiOjE1NjQxMjQwMTAsIm5iZiI6MTU2NDEyNDAxMCwiZXhwIjoxNTY0OTg4MDEwfQ.jz7W86FeDt49G48w_0rStlCvl1Tl90zWURhDBxpmItk

HTTP status code 403

Доступ к API запрещен

/delete

Удаление

delete

token может быть идентификатором файла, или путем до файла

delete

Удаление файла

Удаление файла

Secured by Bearer

URI Parameters

  • token: required(string | integer)

    Example:

    /1 | /path/to/file/example.jpg

HTTP status code 204

HTTP status code 404

File not found.

Secured by Bearer

Headers

  • Authorization: required(string)

    Авторизация по токену

    Example:

    Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwcm9qZWN0IjoibGVnYWxiZXQiLCJzdHJhdGVneSI6ImNvbW1lbnQiLCJlbnYiOiJkZXYiLCJpYXQiOjE1NjQxMjQwMTAsIm5iZiI6MTU2NDEyNDAxMCwiZXhwIjoxNTY0OTg4MDEwfQ.jz7W86FeDt49G48w_0rStlCvl1Tl90zWURhDBxpmItk

HTTP status code 403

Доступ к API запрещен

/list

Список

get

Путь до директории

get

Список файлов по пути

Список файлов по пути

Secured by Bearer

URI Parameters

  • directory: required(string)

    Example:

    web/scripts

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "web/froala_editor/editor.jpg": {
    "path": "web/froala_editor/editor.jpg",
    "dirname": "web/froala_editor",
    "basename": "editor.jpg",
    "extension": "jpg",
    "filename": "editor",
    "timestamp": 1560403662,
    "size": "347338",
    "storageclass": "STANDARD",
    "type": "file",
    "hash": "17f637c08bb22f458b5c9783409bf612"
  },
  "web/froala_editor/img/photo1.jpg": {
    "path": "web/froala_editor/img/photo1.jpg",
    "dirname": "web/froala_editor/img",
    "basename": "photo1.jpg",
    "extension": "jpg",
    "filename": "photo1",
    "timestamp": 1560403659,
    "size": "187900",
    "storageclass": "STANDARD",
    "type": "file",
    "hash": "e4c79d123b14edde15f2652d6983a867"
  },
  "web/froala_editor/img/photo1.png": {
    "path": "web/froala_editor/img/photo1.png",
    "dirname": "web/froala_editor/img",
    "basename": "photo1.png",
    "extension": "png",
    "filename": "photo1",
    "timestamp": 1560403658,
    "size": "417607",
    "storageclass": "STANDARD",
    "type": "file",
    "hash": "56905e83cf5e72aad39f5dcbeb74f69e"
  }
}

Secured by Bearer

Headers

  • Authorization: required(string)

    Авторизация по токену

    Example:

    Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwcm9qZWN0IjoibGVnYWxiZXQiLCJzdHJhdGVneSI6ImNvbW1lbnQiLCJlbnYiOiJkZXYiLCJpYXQiOjE1NjQxMjQwMTAsIm5iZiI6MTU2NDEyNDAxMCwiZXhwIjoxNTY0OTg4MDEwfQ.jz7W86FeDt49G48w_0rStlCvl1Tl90zWURhDBxpmItk

HTTP status code 403

Доступ к API запрещен

/crop

Кроп

put

token может быть идентификатором файла, или путем до файла

put

Кроп изображения по координатам и размерам

Кроп изображения по координатам и размерам

Secured by Bearer

URI Parameters

  • token: required(string | integer)

    Example:

    /1 | /path/to/file/example.jpg

Body

Media type: application/x-www-form-urlencoded

Type: any

Example:

{
  "formParameters": {
    "positionX": {
      "description": "Координата по оси X - левая верхняя позиция вырезаемой области",
      "type": [
        "integer"
      ],
      "example": 50,
      "required": true
    },
    "positionY": {
      "description": "Координата по оси Y - левая верхняя позиция вырезаемой области",
      "type": [
        "integer"
      ],
      "example": 50,
      "required": true
    },
    "cropWidth": {
      "description": "Длина вырезаемой области",
      "type": [
        "integer"
      ],
      "example": 200,
      "required": true
    },
    "cropHeight": {
      "description": "Высота вырезаемой области",
      "type": [
        "integer"
      ],
      "example": 200,
      "required": true
    },
    "resizeWidth": {
      "description": "Длина изменения размеров изображения (опциональный параметр)",
      "type": [
        "integer"
      ],
      "example": 450,
      "required": false
    },
    "resizeHeight": {
      "description": "Высота изменения размеров изображения (опциональный параметр)",
      "type": [
        "integer"
      ],
      "example": 450,
      "required": false
    },
    "prefix": {
      "description": "Префикс названия файла миниатюры",
      "type": [
        "integer"
      ],
      "example": "avatar",
      "required": false
    }
  }
}

HTTP status code 201

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": 746,
    "url": "https://testweb.fra1.digitaloceanspaces.com/cdn/static/00/00/76x17-149x211_5d5b9ac3a5b4b_1566284483.jpg",
    "path": "/cdn/static/00/00/76x17-149x211_5d5b9ac3a5b4b_1566284483.jpg",
    "width": 222,
    "height": 316,
    "ratio": 0.70253164556962022
  }
]

Secured by Bearer

Headers

  • Authorization: required(string)

    Авторизация по токену

    Example:

    Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwcm9qZWN0IjoibGVnYWxiZXQiLCJzdHJhdGVneSI6ImNvbW1lbnQiLCJlbnYiOiJkZXYiLCJpYXQiOjE1NjQxMjQwMTAsIm5iZiI6MTU2NDEyNDAxMCwiZXhwIjoxNTY0OTg4MDEwfQ.jz7W86FeDt49G48w_0rStlCvl1Tl90zWURhDBxpmItk

HTTP status code 403

Доступ к API запрещен