如何从Django内置API文档中排除rest-auth端点？
在Django中，可以通过以下步骤从内置API文档中排除rest-auth端点：
- 创建一个新的Django应用程序，用于扩展和自定义Django的内置功能。
- 在该应用程序的根目录下创建一个新的Python模块，例如"api_docs.py"。
- 在"api_docs.py"中，导入Django的内置API文档生成器：
from django.contrib.admindocs.views import simplify_regex
from django.utils.encoding import force_text- 创建一个新的视图函数，用于生成自定义的API文档：
def custom_api_docs(request):
from django.contrib.admindocs.views import extract_views_from_urlpatterns
from django.urls import get_resolver
resolver = get_resolver()
patterns = resolver.url_patterns
views = []
for pattern in patterns:
if hasattr(pattern, 'callback'):
callback = pattern.callback
if hasattr(callback, '__name__') and callback.__name__ == 'rest_auth':
continue
views += extract_views_from_urlpatterns([pattern])
views.sort(key=lambda x: x[0])
views = [(pattern, simplify_regex(pattern.regex.pattern), name) for pattern, name in views]
return render(request, 'api_docs.html', {'views': views})- 在urls.py文件中，将自定义的视图函数与URL路径进行关联：
from .api_docs import custom_api_docs
urlpatterns = [
# 其他URL路径...
path('api/docs/', custom_api_docs, name='custom_api_docs'),
]- 创建一个新的HTML模板文件，例如"api_docs.html"，用于显示自定义的API文档：
<!DOCTYPE html>
<html>
<head>
<title>Custom API Documentation</title>
</head>
<body>
<h1>Custom API Documentation</h1>
<ul>
{% for view in views %}
<li>
<strong>{{ view.2 }}</strong><br>
<em>{{ view.1 }}</em><br>
<code>{{ view.0.callback.__module__ }}.{{ view.0.callback.__name__ }}</code>
</li>
{% endfor %}
</ul>
</body>
</html>现在，当访问"/api/docs/"路径时，将显示自定义的API文档，其中已排除了rest-auth端点。
请注意，以上代码仅为示例，实际应用中可能需要根据具体情况进行适当修改和调整。此外，腾讯云并没有提供与Django内置API文档排除相关的特定产品或服务。
相关·内容
要在Django文档中隐藏端点，只需将@schema(None)添加到例如GenericAPIView中，但是我对这两个urls有一个问题：url(r'^rest-auth/registration/', include('rest_auth.registration.url
浏览 6提问于2020-05-17得票数 4
回答已采纳
我正在使用的后端创建一个网站(django，django-rest框架)和前端(React.js)。我不清楚如何为密码重置电子邮件创建restfull。
浏览 0提问于2019-06-19得票数 0
我正在使用django rest-auth和allauth在我的网站上进行登录/注销和注册。这些都非常容易使用，并且运行良好。然而，可浏览的API对于生产来说是丑陋的。我想完全定制我的登录视图，同时仍然保留底层的rest-auth逻辑。我该怎么做呢？是否有可以覆盖的默认.html文件？更新
我
浏览 0提问于2019-09-15得票数 1
1回答
我使用Django REST框架创建了Rest，对auth端点使用了django-rest。这些API用于移动应用程序。我使用TokenAuthentication来保护API。这些文档也需要受到保护。(/rest-auth/ login )与CSRF错误中断。{}
那么，如何<
浏览 5提问于2017-11-14得票数 0
回答已采纳
我使用django rest-auth通过django rest框架进行身份验证。对于客户端，我使用了angular 4。从api (drf)登录工作正常。但是，从angular 4登录不起作用，因为其他api端点没有使用该用户登录。 return this.http.post('http:/
浏览 0提问于2018-01-05得票数 0
由于所有用户数据都将通过API检索或提交，那么API身份验证是否就足够了？如果需要，是否需要删除现有的Django身份验证中间件？现在，当我尝试在应用程序的早期版本上点击API端点时，我被引导到了类似于普通Django登录表单的内容。如果我输入一个有效的用户名和密码，它不工作-只是提示再次登录。django包--rest-auth看起来很有用，同一个组构建了一个角度模块--但是文档并没有经过安装和提供的端点。最终，我
浏览 6提问于2016-02-24得票数 5
回答已采纳
我的问题是，当我尝试使用django-rest-auth端点检索访问令牌时，django-allauth会从Reddit返回429错误。但是，当我尝试使用Reddit api文档中列出的所有内容直接调用Reddit api时，我能够成功地执行此操作。我希望能够通过django-rest-auth进行此调用，这样我就可以从它与Django集成的方式中受益。我已经对django
浏览 10提问于2019-04-24得票数 1
回答已采纳
4回答
实现自定义用户时出错
、、、
当django rest和django-rest-auth被安装时，我在下面得到一个错误。/ HTTP/1.1" 200 -127.0.0.1- - [09/Mar/2016 20:34:05] "GET /docs/api</
浏览 3提问于2016-03-06得票数 0
requires either a definition of 'template_name' or an implementation of 'get_template_names()' 我无法理解文档：https://django-rest-auth.readthedocs.io/en/latest/faq.html 目前还不清楚如何一步一步实施。我甚至尝试了下面的链接，但我仍然无法解决这个问题： https://github.
浏览 17提问于2019-09-12得票数 0
2回答
我正在使用django Django=2.1.7和rest框架djangorestframework=3.9.2，这是我用于登录的url当我输入用户名和密码时，我从rest API获得了令牌。请帮助我如何实现。我已经在StackOverflow上看到了很多答案，甚至官方文档都不是描述性的
浏览 37提问于2019-04-20得票数 0
回答已采纳
django-rest-auth文档讨论了Facebook集成，我对此不感兴趣--我关心的是通过Google提供社交登录。我已经尝试了很长一段时间，我想知道是否有人有任何关于他们如何做this...even的文档，只是一个粗略的草图将是有帮助的。到目前为止，我还没有找到这次搜索的任何结果。检查django管理员，一切正常-用户已登录，电子邮件已验证，等等。
问题在于提供“代码”的起始点--以及我如何从google获得代码。为了重新创建无缝流(即不是从代
浏览 3提问于2015-12-24得票数 14
为了实现忘记密码，我使用了django rest auth.Here，下面的urls是： r'^rest-auth/password/reset/$', name='password_reset',url( r'(
浏览 8提问于2019-08-26得票数 0
本教程中的所有内容都运行得很好，但没有解释如何进行密码重置。 我有一个邮箱帐户，正在尝试使用沙箱发送邮件。# api/urls.py path('rest-auth/', include('('users/', include('users.urls')),
] 我正在通过可浏览的A
浏览 14提问于2018-12-29得票数 0
我在Twitter上创建了这个应用程序，根据我查看的文档将所有数据放入模型Social应用程序中： adapter_class = TwitterOAuthAdapter增加网址：]
然后转到链接: /
浏览 0提问于2018-01-18得票数 4
回答已采纳
2回答
我使用django rest-auth和django rest api。我可以通过在可浏览api中调用rest/ logout来注销用户，它将从数据库中删除令牌。在可浏览的api中，我不必将令牌与注销url一起发送。我从React前端调用了相同的url auth/logout，它给出了“成功注销”的响应，但是令牌仍然保留在数据库中。如何通过从前端调用url来删除
浏览 8提问于2020-11-13得票数 0
回答已采纳
我目前正在实现身份验证系统，因此我刚刚将DEFAULT_PERMISSION_CLASSES的DEFAULT_PERMISSION_CLASSES设置从rest_framework.permissions.AllowAny', {
'BACKEND': 'django.template.backends.django.DjangoTemplates，以便
浏览 10提问于2020-06-26得票数 2
3回答
我使用drf为我的Django REST API生成swagger文档。我有两个端点，items/ with、POST和DELETE方法；items/<uuid:itemID>只有DELETE方法。但是，生成的swagger文档错误地包括后一个端点的GET和POST。这是我在urls.py中的一个片段： url(r'^items/$', views.ItemViewSet
浏览 4提问于2018-10-15得票数 2
3回答
我已经使用Django REST Framework很长一段时间了，但是遇到了一种情况，除了API视图中已知的关系之外，我需要检索所有东西。在再次查看文档之后，我看不到任何内置的机制来实现这一点。我意识到我可以在我的get_queryset()中重写ListView并解析自定义的ListView查询参数，然后进行过滤，但是我很好奇是否还有其他人有更优雅的解决方案呢？更新
经过进一步的研究，这似乎更像是一个django过滤器问题，我找不到任何排除功能的地方。我确实找到了这
浏览 4提问于2014-04-22得票数 8
回答已采纳
我正在为我的自定义用户模型使用django-rest-auth作为API端点。获取用户详细信息后，我向GET发送一个/rest-auth/user/请求。这在经过身份验证的用户中很好，但对于未通过身份验证的用户，使用403 Forbidden错误标记是被禁止的。def test_get_user(self):
# /rest-auth/
浏览 0提问于2019-06-24得票数 2
回答已采纳
1回答
我需要帮助Django休息和社交活动..。我对下一个结构有一种看法..。from django.contrib.auth import login
def register_by_access_token(request,如何在我的backend....to中管理csrf令牌，避免拒绝未来的请求……
浏览 2提问于2015-08-07得票数 1
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
实时音视频
即时通信 IM活动推荐
腾讯云开发者
