脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 脚本专栏 → python → django-rest-swagger对API接口注释

django-rest-swagger对API接口注释的方法

 更新时间：2019年08月29日 10:33:37   作者：傲娇的草履虫  
今天小编就为大家分享一篇django-rest-swagger对API接口注释的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧

Swagger是一个API开发者的工具框架，用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端和文件系统服务器以同样的速度来更新，方法，参数和模型紧密集成到服务器端的代码中，允许API始终保持同步。

在使用 django-rest-framework 进行API开发，可以使用django-rest-swagger接入swagger自动生成接口文档。

1. 安装django-rest-swagger

pip install django-rest-swagger

2.配置settings.py

INSTALLED_APPS = [
 ...

 'rest_framework_swagger'

 ...
]

3. views.py

该博文的项目是django-rest-framework中文站点的例子：https://q1mi.github.io/Django-REST-framework-documentation

当需要对接口的各种方法进行注释时，直接在该类下添加注释，如下所示。需要注意是的：注释的方法名称（如 get、post）要对应该类所含的方法名称

class SnippetList(generics.ListCreateAPIView):
 """
 get:
 Return all snippets.
 post:
 Create a new snippet instance.
 """

 queryset = Snippet.objects.all()
 serializer_class = SnippetSerializer
 permission_classes = (permissions.IsAuthenticatedOrReadOnly,)

 def perform_create(self, serializer):
 serializer.save(owner=self.request.user)


class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
 """
 get:
 Return a snippet instance.
 put:
 Update a snippet instance.
 patch:
 Update a snippet instance.
 delete:
 Delete a snippet instance.
 """
 queryset = Snippet.objects.all()
 serializer_class = SnippetSerializer
 permission_classes = (permissions.IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly,)


class UserList(generics.ListAPIView):
 """
 get:
 Return all users
 """
 queryset = MyUser.objects.all()
 serializer_class = UserSerializer


class UserDetail(generics.RetrieveAPIView):
 """
 get:
 Return a user instance
 """
 queryset = MyUser.objects.all()
 serializer_class = UserSerializer


class SnippetHighlight(generics.GenericAPIView):
 """
 get:
 Return a highlight instance
 """
 queryset = Snippet.objects.all()
 renderer_classes = (renderers.StaticHTMLRenderer,)

 def get(self, request, *args, **kwargs):
 snippet = self.get_object()
 return Response(snippet.highlighted)

3.配置urls.py

from rest_framework.schemas import get_schema_view
from rest_framework_swagger.renderers import SwaggerUIRenderer, OpenAPICodec
schema_view = get_schema_view(title='API', renderer_classes=[SwaggerUIRenderer, OpenAPICodec])

urlpatterns = [
 
 ...

 url(r'docs/', schema_view, name='docs')

 ...
]

运行manage.py后，浏览器访问 http://127.0.0.1:8000/，可以看到以下内容：

访问 http://127.0.0.1:8000/docs/，可以看到接口文档如下：

点击打开snippets，可以看到如下，每个方法后面都有你在views.py中添加的注释

点击打开get方法，如下

以上这篇django-rest-swagger对API接口注释的方法就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • python基础之文件的备份以及定位

    python基础之文件的备份以及定位

    这篇文章主要介绍了python文件的备份以及定位,实例分析了Python中返回一个返回值与多个返回值的方法,需要的朋友可以参考下
    2021-10-10
  • python pygame模块编写飞机大战

    python pygame模块编写飞机大战

    这篇文章主要为大家详细介绍了python pygame模块编写飞机大战，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-11-11
  • python实现聊天小程序

    python实现聊天小程序

    这篇文章主要为大家详细介绍了python实现聊天小程序，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-03-03
  • 如何基于python操作json文件获取内容

    如何基于python操作json文件获取内容

    这篇文章主要介绍了如何基于python操作json文件获取内容,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • Python脚本激活Linux密码的方法(crypt模块)

    Python脚本激活Linux密码的方法(crypt模块)

    今天小编给大家分享一个非常不错的方法破解linux口令，主要是利用linux系统中的crypt模块模拟了linux系统中用户密码的加密，操作也很方便，对python破解linux口令相关知识感兴趣的朋友跟随小编一起学习下吧
    2021-05-05
  • Python利用代码计算2个坐标之间的距离

    Python利用代码计算2个坐标之间的距离

    这篇文章主要介绍了Python利用代码计算2个坐标之间的距离,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-08-08
  • 利用Python编写一个藏头诗在线生成器

    利用Python编写一个藏头诗在线生成器

    这篇文章主要介绍了如何利用Python编写一个藏头诗在线生成器，文中的示例代码讲解详细，感兴趣的同学可以跟随小编一起动手尝试一下
    2022-04-04
  • 对pytorch网络层结构的数组化详解

    对pytorch网络层结构的数组化详解

    今天小编就为大家分享一篇对pytorch网络层结构的数组化详解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2018-12-12
  • python 容器总结整理

    python 容器总结整理

    这篇文章主要介绍了python 容器总结整理的相关资料,需要的朋友可以参考下
    2017-04-04
  • 在Python文件中指定Python解释器的方法

    在Python文件中指定Python解释器的方法

    今天小编就为大家分享一篇在Python文件中指定Python解释器的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2019-02-02

最新评论