自动生成接口文档

摘要:
#1.安装pipingstallcoreapi#2.在route_framework中配置fromrest。documentationimportinclude_docs_Urlsurlpatterns=[…path('docs/',include_docs_urls(title='Site Page title')]#3视图类:自动界面文档可以生成从APIView及其子类继承的视图-1)单方法视图,可以直接使用类
#1 安装
pip install coreapi

#2 在路由中配置
    from rest_framework.documentation importinclude_docs_urls

    urlpatterns =[
        ...
        path('docs/', include_docs_urls(title='站点页面标题'))
    ]
    
#3 视图类:自动接口文档能生成的是继承自APIView及其子类的视图。
    -1) 单一方法的视图,可直接使用类视图的文档字符串,如
        classBookListView(generics.ListAPIView):
            """返回所有图书信息.
            """
            
    -2)包含多个方法的视图,在类视图的文档字符串中,分开方法定义,如
        classBookListCreateView(generics.ListCreateAPIView):
            """get:
            返回所有图书信息.
            post:
            新建图书.
            """
            
    -3)对于视图集ViewSet,仍在类视图的文档字符串中封开定义,但是应使用action名称区分,如
        classBookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
            """list:
            返回图书列表数据
            retrieve:
            返回图书详情数据
            latest:
            返回最新的图书数据
            read:
            修改图书的阅读量
            """

免责声明:文章转载自《自动生成接口文档》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇SpringBootSecurity学习(23)前后端分离版之OAuth2.0 其它模式redheat7 sd 0:0:0:0: [sda] Assuming drive cache: write through(未解决)下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

随便看看

运行bat时隐藏cmd窗口

这种方法在击球时仍然闪烁。隐藏和运行蝙蝠文件的几种方法Bat文件是在Windows系统中以命令行模式执行一个或多个命令的批处理文件。然而,大多数脚本在运行时都会弹出黑色背景的DOS窗口,这会让许多用户无所适从,甚至会错误关闭正在运行的窗口。...

爱快路由器的一些注意事项硬件配置+多线负载均衡

以下数据仅供参考:注意:磁带载体的数量因使用环境和带宽大小的不同而不同。此外,请注意32位系统的安装。最大内存为4G,最大内存为3G-----硬盘------安装“爱快路由”时对硬盘的最低要求为1G以上。...

ABB机器人功能程序(FUNC)

功能程序的应用范围非常广泛。熟练的人员可以根据不同的需求创建相应的功能程序。函数程序的固定格式是FUNC,返回结束。在ABB的学习中,许多学生对功能程序几乎一无所知,即使他们真的在使用它。在学习ABB的过程中,我遇到了几个用例,所以我总结了它们以加深我的理解。...

微信分享之分享图片/分享图标不能显示

微信分享的分享图标/图片无法显示,主要是由于以下几个问题:1.确保分享界面调用成功,分享路径正确。2.确保共享图片的路径不使用中文或全半角字符。3.确保副本不包含敏感字符,如红包和收据。当共享接口未能成功加载时,将发生错误。在页面的前面使用隐藏的div来放置要制作缩略图的图片。记住,不能直接隐藏图片。style=“display:noen”,如果没有,则使用...

LaTeX表格tabular背景色添加技巧 [转]

我们所用的宏包为colortbl,这个宏包可以设置表格中数据、文本、行、列、单元格前景和背景以及边框的颜色,从而得到彩色表格。同时需要array和color两个宏包的支持。宏包提供了一组着色命令,经常用到是列着色命令,其格式为:\columncolor[色系]{色名}[左伸出][右伸出]。常用色系有三原色rgb灰度gray和四色cmyk三种;被预定义的色名有...

解决fiddler开启后打开浏览器提示无法访问网络

在使用python接口测试的过程中,jupyter经常被用来调试python代码。因为jupyter的默认代理端口是8888,所以当它启用时,它会打开fiddler数据包捕获并打开浏览器,提示“无法访问网络”。这个问题主要是由港口冲突造成的。您可以在工具选项连接中修改端口号,修改它,然后单击“确定”重新启动fiddler...