美文网首页程序员
django swagger遇到一些问题归总

django swagger遇到一些问题归总

作者: dd1991 | 来源:发表于2019-02-26 17:43 被阅读0次

    swagger 的简介


    官方文档:https://django-rest-swagger.readthedocs.io/en/latest/

    Swagger能成为最受欢迎的REST APIs文档生成工具之一,有以下几个原因:

    Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。

    Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。

    Swagger 文件可以在许多不同的平台上从代码注释中自动生成。

    Swagger 有一个强大的社区,里面有许多强悍的贡献者。


    当我们按照官方文档,我们很容易启动成功!

    ps:      django框架swagger隐藏接口,只需要你在方法体上 定义schema=None 变量即可(这个网上并没有太多的介绍,被坑)

    swagger ui


    那么,我们开始编辑swagger接口了,针对个人在编辑ui的时候遇到问题,主要包含图中红色数字,我们将具体说明如下:

    当我们点击Try it out 会走如下图:

    ①: 我们只需要在方法下注解即可(注意格式,即在ui界面展示效果)

    ②:如果你是no parameters ,你可以考虑使用你model 序列化,导入设置变量

                serializer_class  = NameSerializer ,前提你的类  继承的GenericAPIVeiw

                另外,如果你继承的是 APIVeiw,你可以考虑coreapi 来自定义设置参数,当然我推荐上一种,简单快捷

    coreapi自定义显示参数,即:



    ③:这个整体是归结于你的展示格式,

    from rest_framework.parsersimport FormParser, MultiPartParser

    paeser_classes = (FormParser, MutiPartParser)

    相关文章

      网友评论

        本文标题:django swagger遇到一些问题归总

        本文链接:https://www.haomeiwen.com/subject/qkkcyqtx.html