Django-ShortUrls 技术文档

1. 安装指南

在开始使用 Django-ShortUrls 前，请确保您的环境中已经安装了 Django。

安装步骤：

1. 从 PyPI 安装 Django-ShortUrls：

   pip install django-shorturls
   

2. 在您的 Django 项目的 settings.py 文件中，添加 shorturls 到 INSTALLED_APPS 列表：

   INSTALLED_APPS = [
       # 其他应用...
       'shorturls',
   ]
   

3. 定义短链接的前缀和对应的模型，在 settings.py 中设置 SHORTEN_MODELS：

   SHORTEN_MODELS = {
       'A': 'myapp.animal',
       'V': 'myapp.vegetable',
       'M': 'myapp.mineral'
   }
   

4. 在项目的 URL 配置文件（通常是 urls.py）中，引入短链接的 URL 模式：

   from django.urls import path, include
   
   urlpatterns = [
       # 其他 URL 模式...
       path('short/', include('shorturls.urls')),
   ]
   

5. 如果您想要在模板中快速生成短链接，确保 shorturls 在 INSTALLED_APPS 中，并在模板文件中加载 shorturl 标签：

   {% load shorturl %}
   

2. 项目的使用说明

Django-ShortUrls 允许在 Django 项目中托管自定义的短链接。以下是基本使用方法：

配置短链接模型

在 settings.py 中，通过 SHORTEN_MODELS 设置，定义模型前缀与模型的对应关系。

在 URLconf 中配置重定向视图

在项目的 URL 配置文件中，引入 shorturls 的 URL 模式，以便处理短链接的重定向。

在模板中使用短链接

在模板文件中，加载 shorturl 标签并在模板中使用它来生成短链接。

<a href="{% shorturl object %}">对象的短链接</a>

或者使用 revcanonical 标签来生成规范链接的 <link> 标签。

{% revcanonical object %}

3. 项目API使用文档

Django-ShortUrls 提供了一些设置来控制其行为：

• SHORTEN_MODELS：定义短链接前缀与模型的映射。
• SHORT_BASE_URL：设置短链接的基础 URL 前缀。
• SHORTEN_FULL_BASE_URL：设置从短链接重定向到的完整基础 URL。
• SHORTURLS_DEFAULT_CONVERTER：设置默认的短链接与模型 ID 之间的转换器。

4. 项目安装方式

如前所述，Django-ShortUrls 可以通过 PyPI 使用 pip 进行安装：

pip install django-shorturls

确保遵循安装指南中的步骤，以正确配置您的 Django 项目以使用 Django-ShortUrls。