如下所示:
requirements.txt django==1.10.5 djangorestframework==3.5.3 django-rest-swagger==2.1.1
参考英文文档:
http://django-rest-swagger.readthedocs.io/en/latest/
使用swagger工具结合Django-rest-framework进行restful API的管理以及可视化显示的时候,由于swagger2.1以后不再使用yaml文档描述api,改而使用json描述,虽然swagger有着自动适配url扫描生成文档的能力,可是自动生成的文档并不详细,然而完全通过json文件描述所有的api,工作量比较大,且有的api也不需要详细描述,因而需要自定义api的json描述和自动扫描生成相结合。
实现如下:
swagger_views.py
# -*- coding: utf-8 -*- import json from collections import OrderedDict from openapi_codec import OpenAPICodec from openapi_codec.encode import generate_swagger_object from coreapi.compat import force_bytes from django.conf import settings from rest_framework.views import APIView from rest_framework.response import Response from rest_framework.schemas import SchemaGenerator from rest_framework_swagger.renderers import ( SwaggerUIRenderer, OpenAPIRenderer ) class SwaggerSchemaView(APIView): renderer_classes = [ OpenAPIRenderer, SwaggerUIRenderer ] def load_swagger_json(self, doc): """ 加载自定义swagger.json文档 """ data = generate_swagger_object(doc) with open(settings.API_DOC_PATH) as s: doc_json = json.load(s, object_pairs_hook=OrderedDict) data['paths'].update(doc_json.pop('paths')) data.update(doc_json) return OpenAPICodec().decode(force_bytes(json.dumps(data))) def get(self, request): generator = SchemaGenerator(title='后端API文档', urlconf='chess_user.urls') schema = generator.get_schema(request=request) document = self.load_swagger_json(schema) return Response(document)
urls.py
from django.conf.urls import url, include from django.conf.urls.static import static from .swagger_views import SwaggerSchemaView urlpatterns = [ url(r'^api-doc/$', SwaggerSchemaView.as_view(), name='docs'),
settings.py
SWAGGER_SETTINGS = { 'JSON_EDITOR': True, 'LOGIN_URL': 'login', 'LOGOUT_URL': 'logout', } API_DOC_PATH = os.path.join(BASE_DIR, "api-doc/swagger.json")
api-doc/swagger.json
{ "paths": { "v1/user/profile/": { "get": { "tags": [ "v1" ], "description": "用户profile\n", "responses": { "200": { "description": "OK", "schema": { "title": "User", "type": "object", "properties": { "username": { "type": "string" }, "email": { "type": "string" }, "phone_number": { "type": "string" } } } } } } } } }
若有bug,欢迎指出!
以上这篇django-rest-swagger的优化使用方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持。
免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件!
如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
白云城资源网 Copyright www.dyhadc.com
暂无“django-rest-swagger的优化使用方法”评论...
更新日志
2025年01月10日
2025年01月10日
- 小骆驼-《草原狼2(蓝光CD)》[原抓WAV+CUE]
- 群星《欢迎来到我身边 电影原声专辑》[320K/MP3][105.02MB]
- 群星《欢迎来到我身边 电影原声专辑》[FLAC/分轨][480.9MB]
- 雷婷《梦里蓝天HQⅡ》 2023头版限量编号低速原抓[WAV+CUE][463M]
- 群星《2024好听新歌42》AI调整音效【WAV分轨】
- 王思雨-《思念陪着鸿雁飞》WAV
- 王思雨《喜马拉雅HQ》头版限量编号[WAV+CUE]
- 李健《无时无刻》[WAV+CUE][590M]
- 陈奕迅《酝酿》[WAV分轨][502M]
- 卓依婷《化蝶》2CD[WAV+CUE][1.1G]
- 群星《吉他王(黑胶CD)》[WAV+CUE]
- 齐秦《穿乐(穿越)》[WAV+CUE]
- 发烧珍品《数位CD音响测试-动向效果(九)》【WAV+CUE】
- 邝美云《邝美云精装歌集》[DSF][1.6G]
- 吕方《爱一回伤一回》[WAV+CUE][454M]