Building REST APIs With API Platform and MongoDB

1
git clone <URL to your repository>  

1
RUN apt-get update && apt-get install --no-install-recommends -y \
2
	libcurl4-openssl-dev \
3
    libssl-dev \
4
    && pecl install mongodb \
5
    && docker-php-ext-enable mongodb

1
docker compose build --no-cache

1
MONGODB_URL=<Atlas URI>
2
MONGODB_DB=Test

1
services:
2
  php:
3
    image: ${IMAGES_PREFIX:-}app-php
4
    depends_on:
5
      - pwa
6
    environment:
7
      MONGODB_URL: <Atlas URI>

1
docker compose up --wait

1
docker compose exec php \
2
 composer require doctrine/mongodb-odm-bundle api-platform/doctrine-odm  

1
{
2
    "name": "The Gourmet Spot",
3
    "address": {
4
      "building": "123",
5
      "street": "Elm Street",
6
      "zipcode": "12345"
7
      },
8
    "borough": "Manhattan",
9
    "cuisine": "Italian"
10
}

1
<?php
2
3
namespace App\Document;
4
5
use ApiPlatform\Metadata\ApiResource;
6
use App\Repository\RestaurantRepository;
7
use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
8
use Doctrine\ODM\MongoDB\Mapping\Annotations\Field;
9
use Doctrine\ODM\MongoDB\Mapping\Annotations\Id;
10
11
#[ApiResource]
12
#[Document(collection: 'restaurants')]
13
class Restaurant
14
{
15
    #[Id]
16
    public string $id;
17
18
    #[Field]
19
    public string $name;
20
21
    #[Field]
22
    public array $address;
23
24
    #[Field]
25
    public string $borough;
26
27
    #[Field]
28
    public string $cuisine;
29
}

1
<?php
2
3
namespace App\Document;
4
5
use Doctrine\ODM\MongoDB\Mapping\Annotations\EmbeddedDocument;
6
use Doctrine\ODM\MongoDB\Mapping\Annotations\Field;
7
8
#[EmbeddedDocument]
9
class Address
10
{
11
    #[Field]
12
    public string $building;
13
14
    #[Field]
15
    public string $street;
16
17
    #[Field]
18
    public string $zipcode;
19
}

1
HTTP_PORT=8080 HTTPS_PORT=8443 docker-compose up 

1
https://localhost:8443/docs

1
{
2
    "name": "The Gourmet Spot",
3
    "address": {
4
      "building": "123",
5
      "street": "Elm Street",
6
      "zipcode": "12345"
7
      },
8
   "borough": "Manhattan",
9
   "cuisine": "Italian"
10
}

1
{
2
    "name": "The Gourmet Spot",
3
    "address": {
4
      "building": "123",
5
      "street": "Elm Street",
6
      "zipcode": "12345"
7
      },
8
    "borough": "New York",
9
    "cuisine": "Spanish"
10
}

1
class Restaurant
2
{
3
    #[Id]
4
    public string $id;
5
6
    #[Field]
7
    #[Assert\NotBlank]
8
    #[Assert\Length(max: 255)]
9
    public string $name;
10
11
    #[EmbedOne(targetDocument: Address::class)]
12
    #[Assert\Valid]
13
    public ?Address $address;
14
15
    #[Field]
16
    #[Assert\NotBlank]
17
    public string $borough;
18
19
    #[Field]
20
    #[Assert\NotBlank]
21
    public string $cuisine;
22
}

1
<?php
2
3
namespace App\Validator\Constraints;
4
5
use Symfony\Component\Validator\Constraint;
6
use Symfony\Component\Validator\ConstraintValidator;
7
8
final class MinimalPropertiesValidator extends ConstraintValidator
9
{
10
    public function validate($value, Constraint $constraint): void
11
    {
12
        if (array_diff(['name', 'cuisine', 'bourough'], $value)) {
13
            $this->context->buildViolation($constraint->message)->addViolation();
14
        }
15
    }
16
}

1
<?php
2
3
namespace App\Validator\Constraints;
4
5
use Symfony\Component\Validator\Constraint;
6
7
#[Attribute]
8
class MinimalProperties extends Constraint
9
{
10
    public $message = 'The product must have the minimal properties required ("name", "cuisine", "bourough")';
11
}

1
<?php
2
3
namespace App\Validator\Constraints;
4
5
use Symfony\Component\Validator\Constraint;
6
use Symfony\Component\Validator\ConstraintValidator;
7
8
final class ValidZipcodeValidator extends ConstraintValidator
9
{
10
    public function validate($value, Constraint $constraint): void
11
{
12
        if (!$constraint instanceof ValidZipCode) {
13
            throw new InvalidArgumentException(sprintf('Expected instance of %s, got %s.', ValidZipCode::class, get_class($constraint)));}
14
15
        if (!preg_match('/^[0-9]{5}$/', $value)) {
16
            $this->context->buildViolation($constraint->message)
17
                ->setParameter('{{ value }}', $value)
18
                ->addViolation();}
19
    }
20
}

1
<?php
2
3
namespace App\Validator\Constraints;
4
5
use Symfony\Component\Validator\Constraint;
6
7
#[Attribute]
8
class ValidZipCode extends Constraint
9
{
10
    public $message = 'The zipcode "{{ value }}" is not valid. It must be exactly 5 digits.';
11
}

1
 #[Field]
2
    #[ValidZipCode]
3
        public string $zipcode;

1
{
2
    "name": "Dim Sum Express",
3
    "address": {
4
      "building": "404",
5
      "street": "Chinatown Blvd",
6
      "zipcode": "abcnn"
7
    },
8
    "borough": "Manhattan",
9
    "cuisine": "Chinese"
10
  }

1
The zipcode \"abcnn\" is not valid. It must be exactly 5 digits

1
#[ApiFilter(
2
    SearchFilter::class,
3
    properties: [
4
        'name' => 'ipartial',  The "ipartial" strategy will use a case-insensitive partial match
5
        'cuisine' => 'exact',  The "exact" strategy will use an exact match
6
    ])
7
]

1
db.restaurants.find()
2
[
3
  {
4
    _id: ObjectId('6750aa7acda8e992af0c97b4'),
5
    name: 'The Gourmet Spot',
6
    address: { building: '123', street: 'Elm Street', zipcode: '12345' },
7
    borough: 'Manhattan',
8
    cuisine: 'Italian'
9
  },
10
  {
11
    _id: ObjectId('6750b8406868c9f4fb012be5'),
12
    name: 'Burger Bliss',
13
    address: { building: '789', street: 'Main Street', zipcode: '54321' },
14
    borough: 'Queens',
15
    cuisine: 'American'
16
  },
17
  {
18
    _id: ObjectId('6750b8516868c9f4fb012be8'),
19
    name: 'Curry Delight',
20
    address: { building: '202', street: 'Spice Lane', zipcode: '45678' },
21
    borough: 'Staten Island',
22
    cuisine: 'Indian'
23
  },
24
  {
25
    _id: ObjectId('6750b85e6868c9f4fb012beb'),
26
    name: 'Pasta Paradise',
27
    address: { building: '303', street: 'Olive Way', zipcode: '11223' },
28
    borough: 'Manhattan',
29
    cuisine: 'Italian'
30
  },
31
  {
32
    _id: ObjectId('6750b86e6868c9f4fb012bee'),
33
    name: 'Pizza Kingdom',
34
    address: { building: '606', street: 'Pizza Lane', zipcode: '77889' },
35
    borough: 'Queens',
36
    cuisine: 'Italian'
37
  }
38
]