代码之家 › 专栏 › 技术社区 › eugene

drf yasg,更容易看到特定的终点?

drf-yasg django-rest-framework

eugene · 技术社区 · 5 年前

我们有很多应用程序和端点,当我们使用某些功能时,通过yasg向客户端公开某些端点更容易。

目前,我正在为每个应用程序中的swagger定义单独的url模式,并从上面的url聚合它。

在每个应用程序中执行以下操作(有选择地包括端点)

 router_swagger.register(r'user_coupons', UserCouponViewSet)
 router_swagger.register(r'coupons', CouponViewSet)

 urlpatterns_swagger = [
     url(r'^rest_api/', include(router_swagger.urls)),
 ]

并从其他地方聚合这些模式

swagger_urlpatterns = [                                                                                                                                       
]


from review.urls import urlpatterns_swagger as s1                                                                                                             
swagger_urlpatterns += s1                                                                                                                                     
from saleor.promotion.urls import urlpatterns_swagger as s2                                                                                                   
swagger_urlpatterns += s2

schema_view = get_schema_view(
    openapi.Info(
        title="2019_09",
        default_version='v1',
    ),
    public=True,
    patterns=swagger_urlpatterns,
    permission_classes=[permissions.IsAdminUser],
)


urlpatterns += [
    url(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),

]

它很管用,但有点乏味,不知有没有更好的方法?

0 回复 | 直到 5 年前

-1

Rohit 4 年前

drf-yasg 遵循与DRF相同的模式( https://www.django-rest-framework.org/api-guide/schemas/ )在实施中 get_schema_view .

您可以将生成的swagger文件移动到一个单独的文件中,并将所有图案导入到该文件中,如下所示:

schema_view = get_schema_view(
    openapi.Info(
        title="API",
        default_version="v4",
        description="Some endpoints",
        contact=openapi.Contact(email="contact@snippets.local"),
        license=openapi.License(name="BSD License"),
    ),
    public=True,
    patterns=s1+s2+s3
)

urlpatterns += [
    url(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),

]

推荐文章

Shanmukh Adari · 是否可以更改Django模型中的内置验证器消息

2 年前

Destiny Franks · “int”对象在Django中没有属性“save”?

2 年前

Br0k3nS0u1 · 如何使用Django rest框架在序列化程序中显示query_集的值?

2 年前

Joseph Adam · 如何使用RetrieveAPIView在Django Rest框架中基于特定字段检索数据?

2 年前

moongdal · 我怎样才能像manytomanyfield一样在django admin下拉菜单中选择foreignkey数据?

2 年前

PeterD · 当包含资源时,DRF返回我的软删除记录

2 年前

Destiny Franks · “tuple”对象没有“is_preview”属性

2 年前

Ukena Tora · useState set函数在获取后不工作

2 年前

Zain Khan · 在django rest框架中批量创建记录的最佳方法

2 年前

Vikram Choudhary · 如何在django模型中保存从pdfkit创建的pdf?

2 年前