一个棘手的 Django rest framework 的问题哦

2017-10-31 23:26:45 +08:00
 shuizhengqi

自己在用 django rest framework 配合 swagger 来开发 api,接口功能没问题,主要是不知道如何在 swagger 给自己的 api 进行分类 这个是我目前的效果,所有的东西都显示在了 api 下面,我的 config 和 resource 是用两个 router 去注册的,都是使用的 viewset

这个是我想要达到的效果,可以自己给 api 进行分类,并且在后面加上注释什么的

今天在网上搜了一大堆,都不知道该怎么去解决这个,有没有大神帮忙点拨一下


 url(r'^/api/starry/arsenal/resource/',include(cmdburls.resourceRouter.urls)),
    url(r'^/api/starry/arsenal/config/',include(cmdburls.configRouter.urls)),
resourceRouter = SimpleRouter()
resourceRouter.register(r'ecsList',CMDBviewSet.ecsViewSet)
resourceRouter.register(r'slbList',CMDBviewSet.slbViewSet)
resourceRouter.register(r'ecsIdList',CMDBviewSet.ecsIdViewSet)
configRouter = SimpleRouter()
configRouter.register(r'treeList',CMDBviewSet.treeViewSet)
configRouter.register(r'treeNode',CMDBviewSet.treeNodeDetailViewSet)
2702 次点击
所在节点    Python
4 条回复
wanghaoxi3000
2017-11-01 00:17:54 +08:00
用的 django-rest-swagger 么, 这个好像是默认根据 django 的 apps 来分类的
shuizhengqi
2017-11-01 08:58:54 +08:00
@wanghaoxi3000 不是的呢。我试了一下,感觉像是跟 url pattern 有关,但是又不知道怎么配置
ansheng
2017-11-01 11:52:25 +08:00
我想说你为什么不用 drf 自带的文档生成工具呢?表示我用的很开心。具体参考: http://www.django-rest-framework.org/topics/documenting-your-api/
corningsun
2017-11-01 13:45:36 +08:00
默认是按 app 分类的

手动分类方法是有的,可以参考:

http://www.django-rest-framework.org/api-guide/schemas/#content

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/402429

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX