# django-asyncapi

Generate and host your asyncapi specification using pydantic models


## Installation

Install `django-asyncapi` using `pip` or `poetry`:

```
poetry add django-asyncapi
```

## Usage

1. Create specification

```python

from asyncapi_container.asyncapi.spec.v3.info import Info
from asyncapi_container.containers.v3.simple_spec import SimpleSpecV3
from asyncapi_container.custom_types import RoutingMap
from pydantic import BaseModel, Field


class Customer(BaseModel):
    first_name: str = Field(..., title='First Name')
    last_name: str = Field(..., title='Last Name')
    email: str = Field(..., title='Email')
    country: str = Field(..., title='Country')
    zipcode: str = Field(..., title='Zipcode')
    city: str = Field(..., title='City')
    street: str = Field(..., title='Street')
    apartment: str = Field(..., title='Apartment')


class OrderSchemaV1(BaseModel):
    product_id: int = Field(..., title='Product Id')
    quantity: int = Field(..., title='Quantity')
    customer: Customer


class MySpecialServiceAsyncAPISpecV3(SimpleSpecV3):
    info: Info = Info(
        title="My special Service",
        version="1.0.0",
        description="Service for making orders"
    )
    sends: RoutingMap = {
        "shop.orders.v1": [
            OrderSchemaV1,
        ]
    }
    receives: RoutingMap = {}

```

`"shop.orders.v1"` means topic to which our service produces(sends) message described as `OrderSchemaV1` pydantic model.

2. Add `djanog-asyncapi` to `INSTALLED_APPS`
```python 
INSTALLED_APPS = [
    ...,
    "django_asyncapi",
]
```

3. Setup configuration inside `settings.py`
```python

DJANGO_ASYNCAPI = {
    "ASYNCAPI_SPEC_CLASS": "bus.routing.MySpecialServiceAsyncAPISpecV3",
}
 
```

4. Add `django-asyncapi` urls

```python
from django.urls import path, include

urlpatterns = [
    path('docs/', include('django_asyncapi.urls')),
]

```

5. Enjoy your results by opening `docs/asyncapi/v3`

![alt text](assets/img/result.png)





## Index

```{eval-rst}


.. toctree::
   :maxdepth: 2
    
   api
   tutorial
   config

```