drf-to-mkdoc 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

drf_to_mkdoc/templates/try-out/form.html

@@ -0,0 +1,113 @@
+{% load custom_filters %}
+
+<div class="try-out-form" data-method="{{ method }}">
+    <!-- Base URL Section -->
+    <div class="base-url-section">
+        <label for="baseUrl">Request URL</label>
+        <div class="url-display">
+            <input type="text" id="baseUrl" class="base-url-input" value="http://localhost:8000" placeholder="https://api.example.com">
+            <span class="path-display">{{ path }}</span>
+        </div>
+    </div>
+
+    <!-- Tabs -->
+    <div class="tabs">
+        <button class="tab active" data-tab="parameters">Parameters</button>
+        <button class="tab" data-tab="headers">Headers</button>
+        {% if method|upper in "POST,PUT,PATCH" %}
+        <button class="tab" data-tab="body">Request Body</button>
+        {% endif %}
+    </div>
+
+    <!-- Parameters Tab -->
+    <div class="tab-content active" id="parametersTab">
+        {% if path_params %}
+        <div class="form-group">
+            <label class="form-label">Path Parameters</label>
+            <div class="kv-container" id="pathParams">
+                {% for param in path_params %}
+                <div class="kv-item">
+                    <label class="param-label{% if param.required %} required{% endif %}">{{ param.name }}</label>
+                    <input type="text" 
+                           placeholder="Enter {{ param.name }} value" 
+                           data-param="{{ param.name }}"
+                           {% if param.required %}required{% endif %}>
+                    <div class="error-message"></div>
+                </div>
+                {% endfor %}
+            </div>
+        </div>
+        {% endif %}
+
+        <div class="form-group">
+            <label class="form-label">Query Parameters</label>
+            <div class="kv-container" id="queryParams">
+                <div class="kv-item">
+                    <input type="text" placeholder="Parameter name">
+                    <input type="text" placeholder="Parameter value">
+                    <button class="remove-btn" onclick="TryOutSidebar.removeKvItem(this)">✕</button>
+                </div>
+            </div>
+            <button class="add-btn" onclick="TryOutSidebar.addQueryParam()">
+                <span>+</span> Add Parameter
+            </button>
+        </div>
+    </div>
+
+    <!-- Headers Tab -->
+    <div class="tab-content" id="headersTab">
+        <div class="form-group">
+            <label class="form-label">Request Headers</label>
+            <div class="kv-container" id="requestHeaders">
+                <div class="kv-item">
+                    <input type="text" value="Content-Type">
+                    <input type="text" value="application/json">
+                    <button class="remove-btn" onclick="TryOutSidebar.removeKvItem(this)">✕</button>
+                </div>
+                <div class="kv-item">
+                    <input type="text" value="Authorization">
+                    <input type="text" placeholder="Bearer your-token">
+                    <button class="remove-btn" onclick="TryOutSidebar.removeKvItem(this)">✕</button>
+                </div>
+            </div>
+            <button class="add-btn" onclick="TryOutSidebar.addHeader()">
+                <span>+</span> Add Header
+            </button>
+        </div>
+    </div>
+
+    <!-- Request Body Tab -->
+    {% if method|upper in "POST,PUT,PATCH" %}
+    <div class="tab-content" id="bodyTab">
+        <div class="form-group">
+            <label class="form-label">Request Body</label>
+            <textarea id="requestBody" 
+                      class="form-input form-textarea" 
+                      placeholder="Enter JSON request body..."
+                      rows="8">{% if request_example %}{{ request_example|extract_json_from_markdown }}{% endif %}</textarea>
+        </div>
+    </div>
+    {% endif %}
+
+    <!-- Execute Button -->
+    <button class="execute-btn" id="executeBtn" onclick="executeRequest()">
+        <span>▶</span> Execute Request
+    </button>
+</div>
+
+<script>
+// Pass query parameters data to JavaScript
+window.queryParametersData = {
+    {% if query_parameters %}
+    filter_fields: {{ query_parameters.filter_fields|default:"[]"|safe }},
+    search_fields: {{ query_parameters.search_fields|default:"[]"|safe }},
+    ordering_fields: {{ query_parameters.ordering_fields|default:"[]"|safe }},
+    pagination_fields: {{ query_parameters.pagination_fields|default:"[]"|safe }}
+    {% else %}
+    filter_fields: [],
+    search_fields: [],
+    ordering_fields: [],
+    pagination_fields: []
+    {% endif %}
+};
+</script>

drf_to_mkdoc/templates/try-out/main.html

@@ -0,0 +1,4 @@
+<!-- Try Out Main Component -->
+{% include 'try-out/fab.html' %}
+{% include 'try-out/modal.html' %}
+{% include 'try-out/response-modal.html' %}

drf_to_mkdoc/templates/try-out/modal.html

@@ -0,0 +1,14 @@
+<!-- Try Out Modal -->
+<div id="tryOutModal" class="try-out-modal" role="dialog" aria-modal="true" aria-label="Try It Out">
+    <div class="modal-overlay" onclick="TryOutSidebar.closeTryOut()"></div>
+    <div class="modal-content">
+        <div class="modal-header">
+            <span>🚀</span>
+            <h3>Try It Out</h3>
+            <button class="modal-close" aria-label="Close" onclick="TryOutSidebar.closeTryOut()">✕</button>
+        </div>
+        <div class="modal-body">
+            {% include 'try-out/form.html' %}
+        </div>
+    </div>
+</div>

drf_to_mkdoc/templates/try-out/response-modal.html

@@ -0,0 +1,20 @@
+<!-- Response Modal -->
+<div id="responseModal" class="response-modal" role="dialog" aria-modal="true" aria-label="API Response">
+    <div class="modal-overlay" onclick="TryOutSidebar.closeResponseModal()"></div>
+    <div class="modal-content">
+        <div class="modal-header">
+            <h3>API Response</h3>
+            <button class="modal-close" aria-label="Close" onclick="TryOutSidebar.closeResponseModal()">✕</button>
+        </div>
+        <div class="modal-body">
+            <div class="response-header">
+                <div class="response-info">
+                    <span>Status:</span>
+                    <span class="status-badge" id="modalStatusBadge"></span>
+                </div>
+                <div class="response-info" id="responseInfo"></div>
+            </div>
+            <div class="response-body" id="modalResponseBody"></div>
+        </div>
+    </div>
+</div>

drf_to_mkdoc/templatetags/custom_filters.py

@@ -0,0 +1,148 @@
+import html
+import json
+import re
+
+from django import template
+from django.templatetags.static import static as django_static
+from django.utils.safestring import mark_safe
+
+from drf_to_mkdoc.utils.commons.operation_utils import (
+    format_method_badge as format_method_badge_util,
+)
+
+register = template.Library()
+
+
+@register.filter
+def is_foreign_key(field_type):
+    return field_type in ["ForeignKey", "OneToOneField"]
+
+
+@register.simple_tag
+def static_with_prefix(path, prefix=""):
+    """Add prefix to static path"""
+    return django_static(prefix + path)
+
+
+@register.filter
+def format_method_badge(method):
+    """Format HTTP method as badge"""
+    return format_method_badge_util(method)
+
+
+@register.filter
+def get_display_name(field_name, field_type):
+    if field_type in ["ForeignKey", "OneToOneField"]:
+        return f"{field_name}_id"
+    return field_name
+
+
+@register.filter
+def split(value, delimiter=","):
+    return value.split(delimiter)
+
+
+@register.filter
+def cut(value, arg):
+    return value.split(arg)[1] if "." in value else value
+
+
+@register.filter
+def get_item(dictionary, key):
+    return dictionary.get(key, "")
+
+
+@register.filter
+def format_field_type(field_info):
+    field_type = field_info.get("type", "")
+    if field_type == "ForeignKey":
+        return f"ForeignKey | {field_info.get('field_specific', {}).get('to', '')}"
+    if field_type == "CharField":
+        max_length = field_info.get("max_length", "")
+        return f"CharField | {field_info.get('verbose_name', '')} | max_length={max_length}"
+    return field_type
+
+
+@register.filter
+def format_field_extra(field_info):
+    extras = []
+    if field_info.get("null"):
+        extras.append("null=True")
+    if field_info.get("blank"):
+        extras.append("blank=True")
+    if field_info.get("unique"):
+        extras.append("unique=True")
+    if field_info.get("primary_key"):
+        extras.append("primary_key=True")
+    if field_info.get("max_length"):
+        extras.append(f"max_length={field_info['max_length']}")
+    return ", ".join(extras)
+
+
+@register.filter
+def yesno(value, arg=None):
+    """
+    Given a string mapping values for true, false and (optionally) None,
+    return one of those strings according to the value.
+    """
+    if arg is None:
+        arg = "yes,no,maybe"
+    bits = arg.split(",")
+    if len(bits) < 2:
+        return value  # Invalid arg.
+    try:
+        yes, no, maybe = bits
+    except ValueError:
+        yes, no, maybe = bits[0], bits[1], bits[1]
+
+    if value is None:
+        return maybe
+    if value:
+        return yes
+    return no
+
+
+@register.filter
+def format_json(value):
+    if isinstance(value, str):
+        value = html.unescape(value)
+        try:
+            parsed = json.loads(value)
+            value = json.dumps(parsed, indent=2)
+        except (json.JSONDecodeError, TypeError):
+            pass
+    elif isinstance(value, dict | list):
+        value = json.dumps(value, indent=2)
+
+    return mark_safe(f"```json\n{value}\n```")  # noqa: S308
+
+
+@register.filter
+def extract_json_from_markdown(value):
+    """Extract JSON content from markdown code blocks"""
+    if not isinstance(value, str):
+        return ""
+
+    # Look for ```json code blocks
+
+    json_pattern = r"```json\s*\n(.*?)\n```"
+    matches = re.findall(json_pattern, value, re.DOTALL)
+
+    if matches:
+        return matches[0].strip()
+
+    # Fallback: look for any code block
+    code_pattern = r"```\s*\n(.*?)\n```"
+    matches = re.findall(code_pattern, value, re.DOTALL)
+
+    if matches:
+        content = matches[0].strip()
+        # Try to validate if it's JSON
+        try:
+            json.loads(content)
+        except (json.JSONDecodeError, TypeError):
+            pass
+        else:
+            return content
+
+    return ""

drf_to_mkdoc/utils/commons/schema_utils.py

@@ -1,8 +1,9 @@
 import json
+from copy import deepcopy
+from functools import lru_cache
 from pathlib import Path
 from typing import Any
 
-import yaml
 from drf_spectacular.generators import SchemaGenerator
 
 from drf_to_mkdoc.conf.settings import drf_to_mkdoc_settings
@@ -21,16 +22,6 @@ class QueryParamTypeError(Exception):
     pass
 
 
-def load_schema() -> dict[str, Any] | None:
-    """Load the OpenAPI schema from doc-schema.yaml"""
-    schema_file = Path(drf_to_mkdoc_settings.CONFIG_DIR) / "doc-schema.yaml"
-    if not schema_file.exists():
-        return None
-
-    with schema_file.open(encoding="utf-8") as f:
-        return yaml.safe_load(f)
-
-
 def get_custom_schema():
     custom_schema_data = load_json_data(
         drf_to_mkdoc_settings.CUSTOM_SCHEMA_FILE, raise_not_found=False
@@ -56,7 +47,6 @@ def get_custom_schema():
                         "search_fields",
                         "filter_fields",
                         "ordering_fields",
-                        "filter_backends",
                         "pagination_fields",
                     }
                 ):
@@ -153,16 +143,17 @@ def _apply_custom_overrides(
                 target_schema[key] = custom_value
 
 
+@lru_cache(maxsize=1)
 def get_schema():
     base_schema = SchemaGenerator().get_schema(request=None, public=True)
     custom_data = get_custom_schema()
     if not custom_data:
-        return base_schema
+        return deepcopy(base_schema)
 
     operation_map = _build_operation_map(base_schema)
     _apply_custom_overrides(base_schema, operation_map, custom_data)
 
-    return base_schema
+    return deepcopy(base_schema)
 
 
 class OperationExtractor: