Django Swagger 设置 Https

Swagger是一种简洁、强大的API文档工具。使用Django Swagger可以轻松地为Django应用程序生成Swagger文档。在本文中，我们将介绍如何通过Django Swagger来设置HTTPS连接。

前置条件

在开始设置HTTPS连接之前，我们需要确保以下几点：

• 拥有一个可用的网站域名。
• 已安装Django Swagger。
• 已为网站申请和配置了SSL证书。

步骤

1. 配置Django应用程序的settings.py文件，启用HTTPS连接：

   SECURE_SSL_REDIRECT = True
   SESSION_COOKIE_SECURE = True
   CSRF_COOKIE_SECURE = True
   

   这些设置将强制所有HTTP请求重定向到HTTPS连接。

2. 修改Swagger文档的URL路径以使用HTTPS连接。在Django Swagger的urls.py文件中添加以下代码：

   from django.views.generic.base import RedirectView
   from django.conf.urls import url
   from django_swagger.views import get_swagger_view
   
   schema_view = get_swagger_view(title='API Docs')
   
   urlpatterns = [
       url(r'^$', RedirectView.as_view(pattern_name='schema-swagger-ui')),
       url(r'^api-docs/$', schema_view),
       url(r'^swagger/$', RedirectView.as_view(pattern_name='schema-swagger-ui')),
       url(r'^swagger/(?P<format>.*)$', schema_view),
   ]
   

   通过将Swagger API文档的URL路径绑定到schema_view变量和RedirectView类，我们可以确保文档使用HTTPS连接。

3. 通过在nginx或Apache等Web服务器中配置代理，将HTTPS请求转发到Django应用程序。

   配置示例（nginx）：

   server {
       listen 80;
       server_name yourdomain.com;
       return 301 https://$server_name$request_uri;
   }
   
   server {
       listen 443 ssl;
       server_name yourdomain.com;
   
       ssl_certificate /etc/ssl/yourdomain.com.crt;
       ssl_certificate_key /etc/ssl/yourdomain.com.key;
   
       location / {
           include proxy_params;
           proxy_pass http://localhost:8000;
           proxy_set_header Host $host;
           proxy_set_header X-Real-IP $remote_addr;
           proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
           proxy_set_header X-Forwarded-Proto $scheme;
           add_header Front-End-Https on;
       }
   }
   

   通过将proxy_pass参数设置为Django应用程序的URL，并启用X-Forwarded-Proto头信息，我们可以正确地将HTTPS请求代理到Django应用程序。

结论

在本教程中，我们介绍了如何通过将Django应用程序配置为强制使用HTTPS连接以及在Django Swagger中配置HTTPS连接和URL路径来设置Swagger API文档的HTTPS连接。这将确保我们的API文档安全且可靠。