django-rest-swagger的优化使用方法

框架(架构)  /  管理员 发布于 7年前   173

如下所示：

requirements.txtdjango==1.10.5djangorestframework==3.5.3django-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 jsonfrom collections import OrderedDictfrom openapi_codec import OpenAPICodecfrom openapi_codec.encode import generate_swagger_objectfrom coreapi.compat import force_bytesfrom django.conf import settingsfrom rest_framework.views import APIViewfrom rest_framework.response import Responsefrom rest_framework.schemas import SchemaGeneratorfrom 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, includefrom django.conf.urls.static import staticfrom .swagger_views import SwaggerSchemaViewurlpatterns = [ 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的优化使用方法就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持。