Merge branch 'develop' into feature/docker-dev

.gitignore

@@ -160,3 +160,6 @@ cython_debug/
 .idea/
 media/
 .DS_Store
+
+# Vscode project settings
+.vscode

README.md

@@ -11,6 +11,14 @@ npx --package=@softwaretechnik/dbml-renderer -- dbml-renderer -i docs/db.dbml -o
 [СХЕМА БД](https://dbdiagram.io/d/64bb081202bd1c4a5e7f8c0b)
 
 
+
+## Документация API
+В проекте реализована автоматическая генерация документации. Документация доступна по адресам:
+1) Swagger: `/api/v1/schema/swagger-ui/`
+2) Redoc: `/api/v1/schema/redoc/`
+
+
+
 ## Запуск в режиме разработки
 
 1. Убедитесь, что у вас установлены Docker и Docker Compose.
@@ -58,3 +66,11 @@ npx --package=@softwaretechnik/dbml-renderer -- dbml-renderer -i docs/db.dbml -o
    ```bash
    docker-compose -f infra/docker-compose.dev.yml down
    ```
+=======
+# backend
+
+## Схема базы данных
+Обновление картинки после изменения dbml с помощью команды:
+```
+npx --package=@softwaretechnik/dbml-renderer -- dbml-renderer -i docs/db.dbml -o docs/db.svg
+```

config/settings.py

@@ -29,6 +29,8 @@
 ]
 
 THIRD_PARTY_APPS = [
+    "debug_toolbar",
+    "drf_spectacular",
     "rest_framework",
 ]
 
@@ -49,6 +51,7 @@
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
+    "debug_toolbar.middleware.DebugToolbarMiddleware",
 ]
 
 ROOT_URLCONF = "config.urls"
@@ -126,3 +129,18 @@
 # https://docs.djangoproject.com/en/4.1/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+if DEBUG:
+    INTERNAL_IPS = ["127.0.0.1"]
+
+REST_FRAMEWORK = {
+    "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
+}
+
+SPECTACULAR_SETTINGS = {
+    "TITLE": "b2b-marketplace",
+    "DESCRIPTION": (
+        "API веб-сервиса для взаимодействия между продавцами и покупателями оптовых товаров"
+    ),
+    "VERSION": "0.0.1",
+}

config/urls.py

@@ -1,6 +1,37 @@
 from django.contrib import admin
-from django.urls import path
+from django.urls import include, path
+from drf_spectacular.views import (
+    SpectacularAPIView,
+    SpectacularRedocView,
+    SpectacularSwaggerView,
+)
+
+from config.settings import DEBUG
+
+api_schema_url_patterns = [
+    path(
+        route="",
+        view=SpectacularAPIView.as_view(),
+        name="schema",
+    ),
+    path(
+        route="redoc/",
+        view=SpectacularRedocView.as_view(url_name="schema"),
+        name="redoc",
+    ),
+    path(
+        route="swagger-ui/",
+        view=SpectacularSwaggerView.as_view(url_name="schema"),
+        name="swagger-ui",
+    ),
+]
 
 urlpatterns = [
+    path(route="api/v1/schema/", view=include(api_schema_url_patterns)),
     path("admin/", admin.site.urls),
 ]
+
+if DEBUG:
+    import debug_toolbar
+
+    urlpatterns += [path("__debug__/", include(debug_toolbar.urls))]