Django REST Swaggerで応答メッセージのリストを生成する方法は？
Django REST Frameworkを昨日3.5.0にアップグレードしました。ニーススキーマの生成が必要だからです。
私はDjango REST Swaggerを使用してAPIを文書化していますが、すべての可能な応答メッセージをリストする方法がわかりませんAPIエンドポイントが提供します。
エンドポイントが実行しているアクションに対応する成功メッセージの自動生成があるようです。
したがって、POSTアクションは、説明なしで201応答コードを生成します。
エンドポイントが提供するすべての応答メッセージを追加し、それらにいくつかの説明を与えるにはどうすればよいですか？
使ってます
djangorestframework==3.5.0
Django-rest-swagger==2.0.7
ああ、やっと得た。
だが！これはハックオンハックです。おそらくdrf + drf swaggerはサポートしていません。基本的に、問題はdrfおよびdrf swaggerコードではなく、openapiコーデックに関連しています。自分自身を確認してください。
def _get_responses(link):
"""
Returns minimally acceptable responses object based
on action / method type.
"""
template = {'description': ''}
if link.action.lower() == 'post':
return {'201': template}
if link.action.lower() == 'delete':
return {'204': template}
return {'200': template}
上記のコードは次の場所にあります：openapi_codec/encode.py- github これはdrfやdrf swaggerとはまったく関係がありません-各リンク（例：GET/api/v1/test /）についてのみ、空の説明を含むテンプレートを作成します。
もちろん、この問題を克服する可能性があります。しかし、私が言ったように-これはハックオンハックです:)私はあなたと例を共有します：
docs_swagger.views.py
from rest_framework import exceptions
from rest_framework.permissions import AllowAny
from rest_framework.renderers import CoreJSONRenderer
from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework_swagger import renderers
from docs_swagger.schema_generator import CustomSchemaGenerator
def get_swagger_view(title=None, url=None):
"""
Returns schema view which renders Swagger/OpenAPI.
(Replace with DRF get_schema_view shortcut in 3.5)
"""
class SwaggerSchemaView(APIView):
_ignore_model_permissions = True
exclude_from_schema = True
permission_classes = [AllowAny]
renderer_classes = [
CoreJSONRenderer,
renderers.OpenAPIRenderer,
renderers.SwaggerUIRenderer
]
def get(self, request):
generator = CustomSchemaGenerator(title=title, url=url) # this is altered line
schema = generator.get_schema(request=request)
if not schema:
raise exceptions.ValidationError(
'The schema generator did not return a schema Document'
)
return Response(schema)
return SwaggerSchemaView.as_view()
CustomSchemaGeneratorで私が行うことは次のとおりです。
docs_swagger.schema_generator.py
import urlparse
import coreapi
from rest_framework.schemas import SchemaGenerator
from openapi_codec import encode
def _custom_get_responses(link):
detail = False
if '{id}' in link.url:
detail = True
return link._responses_docs.get(
'{}_{}'.format(link.action, 'list' if not detail else 'detail'),
link._responses_docs
)
# Very nasty; Monkey patching;
encode._get_responses = _custom_get_responses
class CustomSchemaGenerator(SchemaGenerator):
def get_link(self, path, method, view):
"""
Return a `coreapi.Link` instance for the given endpoint.
"""
fields = self.get_path_fields(path, method, view)
fields += self.get_serializer_fields(path, method, view)
fields += self.get_pagination_fields(path, method, view)
fields += self.get_filter_fields(path, method, view)
if fields and any([field.location in ('form', 'body') for field in fields]):
encoding = self.get_encoding(path, method, view)
else:
encoding = None
description = self.get_description(path, method, view)
if self.url and path.startswith('/'):
path = path[1:]
# CUSTOM
data_link = coreapi.Link(
url=urlparse.urljoin(self.url, path),
action=method.lower(),
encoding=encoding,
fields=fields,
description=description
)
data_link._responses_docs = self.get_response_docs(path, method, view)
return data_link
def get_response_docs(self, path, method, view):
return view.responses_docs if hasattr(view, 'responses_docs') else {'200': {
'description': 'No response docs definition found.'}
}
そして最後に：
my_view.py
class TestViewSet(viewsets.ModelViewSet):
queryset = Test.objects.all()
serializer_class = TestSerializer
responses_docs = {
'get_list': {
'200': {
'description': 'Return the list of the Test objects.',
'schema': {
'type': 'array',
'items': {
'type': 'object',
'properties': {
'id': {
'type': 'integer'
}
}
}
}
},
'404': {
'description': 'Not found',
'schema': {
'type': 'object',
'properties': {
'message': {
'type': 'string'
}
}
},
'example': {
'message': 'Not found.'
}
}
},
'get_detail': {
'200': {
'description': 'Return single Test object.',
'schema': {
'type': 'object',
'properties': {
'id': {
'type': 'integer'
}
}
}
},
'404': {
'description': 'Not found.',
'schema': {
'type': 'object',
'properties': {
'message': {
'type': 'string'
}
}
},
'example': {
'message': 'Not found.'
}
}
}
}
私はこれを実際の解決策ではなく楽しいように考えています。現在の状態では、実際の解決策はおそらく実現不可能です。 drf swaggerの作成者に質問する必要があるかもしれません-回答をサポートする計画はありますか？
とにかく、Swagger UI： 
ハッピーコーディング:)