https://github.com/lukasbecvar/api-base

Base app template for creating REST API in the Symfony framework.
https://github.com/lukasbecvar/api-base

api api-base api-template base jwt-auth php rest-api symfony user-system

Last synced: 9 months ago
JSON representation

Base app template for creating REST API in the Symfony framework.

Host: GitHub
URL: https://github.com/lukasbecvar/api-base
Owner: lukasbecvar
License: mit
Created: 2024-12-17T13:10:13.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2025-02-04T15:25:18.000Z (11 months ago)
Last Synced: 2025-02-13T03:29:55.139Z (11 months ago)
Topics: api, api-base, api-template, base, jwt-auth, php, rest-api, symfony, user-system
Language: PHP
Homepage:
Size: 286 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.MD
- License: LICENSE

Awesome Lists containing this project

README

          # Symfony API Base

This is a base application for a REST API in the Symfony framework that I created to speed up backend development.

## Index

* [Features](#features)

* [API-Documentation](#api-documentation)

* [Authentication](#authentication)

* [Error handling](#error-handling)

* [Logging system](#logging-system)

* [User system](#user-system)

* [CLI commands](#cli-commands)

* [Environment configuration variables](#environment-configuration-variables)

* [Request examples](#request-examples)

* [Dependencies & requirements](#dependencies--requirements)

* [License](#license)

## Features

The base contains essential utilities and functions for validation, logging, error handling, and the user system.

## API-Documentation

##### Nelmio UI

The documentation for API endpoints can be found at the route `/api/doc`, with Nelmio UI complete documentation and also allows testing requests directly in the web browser. Alternatively, you can find documentation in JSON format at `/api/doc.json` (You can use this JSON response to import the configuration into Postman).

## Authentication 

##### API-Token

All API requests must have static X-API-Token header set, which is used for validating the request. The token is set in the .env file.

## Error handling

Error handling is managed by the ```handleError``` function in the ```ErrorManager class```, which triggers an exception that is listened to by the ```ExceptionEventSubscriber```. The subscriber logs the exception into the exception log and displays an error response for the user.

## Logging system

For logging, there is the ```LogManager class```, which contains functions for saving and reading logs from the database through the Log entity.

## User system

The user system is managed by the ```UserManager class```, and login works using a JWT token in the authorization header, thanks to Symfony Security and Lexik JWT.

## CLI commands

The application has CLI commands for the LogManager and UserManager, and overall system management through the CLI.

## Environment configuration variables

| Variable | Description | Example value |

| --- | --- | --- |

| `APP_ENV` | Specific environment name | `dev` |

| `APP_SECRET` | Session & token encryption key | `369af56dccfce490cb9325e8b4b59a90` |

| `API_TOKEN` | API access token for authentication | `1234` |

| `APP_VERSION` | App version identifier | `1.0` |

| `TRUSTED_HOSTS` | Trusted domain names | `^.*$` |

| `ALLOWED_IP_ADDRESSES` | Allowed ip addresses (use % for all IP addresses) | `%` |

| `SSL_ONLY` | Enable only SSL traffic (true/false) | `false` |

| `MAINTENANCE_MODE` | Enable maintenance mode (true/false) | `false` |

| `LIMIT_CONTENT_PER_PAGE` | Pagination config (int value) | `10` |

| `REGISTRATION_WITH_API_ENDPOINT_ENABLED` | Enable registration API endpoint (true/false) | `true` |

| `DATABASE_LOGGING` | Log manager config | `true` |

| `LOG_LEVEL` | Log level (1: CRITICAL, 2: WARNING, 3: NOTICE, 4: INFO) | `4` |

| `DATABASE_DRIVER` | Database driver | `pdo_mysql` |

| `DATABASE_HOST` | Database host | `127.0.0.1` |

| `DATABASE_PORT` | Database port | `3306` |

| `DATABASE_NAME` | Database name | `product_vault` |

| `DATABASE_USERNAME` | Database username | `root` |

| `DATABASE_PASSWORD` | Database password | `root` |

| `REDIS_SCHEME` | Redis scheme | `redis` |

| `REDIS_HOST` | Redis host | `127.0.0.1` |

| `REDIS_PORT` | Redis port | `6379` |

| `REDIS_USER` | Redis user | `default` |

| `REDIS_PASSWORD` | Redis password | `redis_test_password` |

| `JWT_TOKEN_TTL` | JWT token TTL (in seconds) | `2629536` (1 month token expiration) |

| `JWT_SECRET_KEY` | JWT secret key | `%kernel.project_dir%/config/jwt/private.pem` |

| `JWT_PUBLIC_KEY` | JWT public key | `%kernel.project_dir%/config/jwt/public.pem` |

| `JWT_PASSPHRASE` | JWT passphrase | `f82fdd5f4644df4ba8fe9df82fdd5f4644df4ba8fe9d` |

| `MAILER_ENABLED` | Enable mailer | `false` |

| `MAILER_HOST` | Mailer host | `smtp.seznam.cz` |

| `MAILER_PORT` | Mailer port | `465` |

| `MAILER_USERNAME` | Mailer username | `service@becvar.xyz` |

| `MAILER_PASSWORD` | Mailer password | `password` |

## Request examples

All requests accept input data in JSON format and return JSON data back to the client.

##### register request

```

curl -X POST http://localhost/api/auth/register \

    -H "Content-Type: application/json" \

    -H "X-API-TOKEN: 1234" \

    -d '{

        "email": "test@example.com",

        "first-name": "John",

        "last-name": "Doe",

        "password": "securePassword123"

    }'

```

##### login request

```

curl -X POST http://localhost/api/auth/login \

    -H "Content-Type: application/json" \

    -H "X-API-TOKEN: 1234" \

    -d '{

        "email": "test@test.test",

        "password": "test"

    }'

```

##### logout request

```

curl -X POST http://localhost/api/auth/logout \

    -H "Content-Type: application/json" \

    -H "X-API-TOKEN: 1234" \

    -H "Authorization: Bearer "

```

##### user info request

```

curl -X GET http://localhost/api/user/info \

    -H "Content-Type: application/json" \

    -H "X-API-TOKEN: 1234" \

    -H "Authorization: Bearer "

```

##### update user password request

```

curl -X PATCH http://localhost/api/user/data/update/password \

    -H "Content-Type: application/json" \

    -H "X-API-TOKEN: 1234" \

    -H "Authorization: Bearer " \

    -d '{

        "new-password": "asdfghjkoiuzrewq"

    }'

```

##### update user role request

```

curl -X PATCH http://localhost/api/user/data/update/role \

    -H "Content-Type: application/json" \

    -H "X-API-TOKEN: 1234" \

    -H "Authorization: Bearer " \

    -d '{

        "user-id": 1,

        "task": "add",

        "role": "ROLE_TEST"

    }'

```

##### update user status request

```

curl -X PATCH http://localhost/api/user/data/update/status \

    -H "Content-Type: application/json" \

    -H "X-API-TOKEN: 1234" \

    -H "Authorization: Bearer " \

    -d '{

        "user-id": 2,

        "status": "idk"

    }'

```

##### delete user request

```

curl -X PATCH http://localhost/api/user/delete \

    -H "Content-Type: application/json" \

    -H "X-API-TOKEN: 1234" \

    -H "Authorization: Bearer " \

    -d '{

        "user-id": 3

    }'

```

##### get users list request

```

curl -X GET http://localhost/api/user/list \

    -H "Content-Type: application/json" \

    -H "X-API-TOKEN: 1234" \

    -H "Authorization: Bearer "

```

## Dependencies & requirements

* PHP 8.3

    * [Website](https://php.net)

* Redis

    * [Website](https://redis.io)

* MySQL

    * [Website](https://www.mysql.com)

* Symfony framework

    * [Website](https://symfony.com)

* Doctrine ORM

    * [Github](https://github.com/doctrine/orm)

* Lexik JWT Authentication Bundle

    * [Github](https://github.com/lexik/LexikJWTAuthenticationBundle)

* PHPUnit

    * [Github](https://github.com/sebastianbergmann/phpunit)

* Better PHPUnit CLI output

    * [Github](https://github.com/robiningelbrecht/phpunit-pretty-print)

* PHPStan

    * [Github](https://github.com/phpstan/phpstan)

## License

This software is licensed under the [MIT license](LICENSE).

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/lukasbecvar/api-base

Awesome Lists containing this project

README