https://github.com/polar-nik/task-api

https://github.com/polar-nik/task-api

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/polar-nik/task-api
• Owner: polar-nik
• Created: 2024-11-08T14:54:54.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-11-11T09:02:01.000Z (7 months ago)
• Last Synced: 2025-01-21T16:45:38.678Z (4 months ago)
• Language: PHP
• Size: 81.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Task API

RESTful API для управления задачами

# Установка

```console

docker-compose up -d

cd www/

composer i

php artisan key:generate

```

По умолчанию используется 8080 порт

# Общее

Все ответы содержат ключ (_boolean_) `success` , который является признаком успешного выполнения запроса

Документация находится http://localhost:8080/api/documentation

# Авторизация:

Для получения токена необходимо зарегистрироваться:

`http://localhost:8080/auth/sign-up`

Или авторизоваться:

`http://localhost:8080/auth/sign-in`

При успешном запросе в обоих случаях вернётся ответ

```json

{

    "success": true,

    "token": "..."

}

```

# Тестирование

Для запуска тестов выполните

```console

php artisan test

```