Briq/drf-yasg
8
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Rewrite schema generation (#1)

Browse Source 
* Completeley rewritten schema generation
* Added support for python 2.7 and 3.4
* Restructured testing and build configuration
* Added nested request schemas

This rewrite completely replaces the public interface of the django rest schema generation library, so 
further changes will be needed to re-enable and further extend the customization points one might want.
This commit is contained in:
Cristi Vîjdea
2017-12-05 19:46:02 +01:00
committed by GitHub
parent 5658910711
commit dce00156d5
55 changed files with 1512 additions and 346 deletions
Download Patch File Download Diff File Expand all files Collapse all files
testproj/testproj/settings.py
+4 -1
View File
@@ -30,7 +30,9 @@ INSTALLED_APPS = [
'corsheaders',
'drf_swagger',
'snippets'
'snippets',
'users',
'articles',
]
MIDDLEWARE = [
@@ -42,6 +44,7 @@ MIDDLEWARE = [
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
'drf_swagger.middleware.SwaggerExceptionMiddleware',
]
ROOT_URLCONF = 'testproj.urls'
testproj/testproj/tests.py
-91
View File
@@ -1,91 +0,0 @@
import json
from django.test import TestCase
from ruamel import yaml
from drf_swagger import openapi, codecs
from drf_swagger.generators import OpenAPISchemaGenerator
class SchemaGeneratorTest(TestCase):
def setUp(self):
self.generator = OpenAPISchemaGenerator(
info=openapi.Info("Test generator", "v1"),
version="v2",
)
self.codec_json = codecs.OpenAPICodecJson(['flex', 'ssv'])
self.codec_yaml = codecs.OpenAPICodecYaml(['ssv', 'flex'])
def _validate_schema(self, swagger):
from flex.core import parse as validate_flex
from swagger_spec_validator.validator20 import validate_spec as validate_ssv
validate_flex(swagger)
validate_ssv(swagger)
def test_schema_generates_without_errors(self):
self.generator.get_schema(None, True)
def test_schema_is_valid(self):
swagger = self.generator.get_schema(None, True)
self.codec_yaml.encode(swagger)
def test_invalid_schema_fails(self):
bad_generator = OpenAPISchemaGenerator(
info=openapi.Info(
"Test generator", "v1",
contact=openapi.Contact(name=69, email=[])
),
version="v2",
)
swagger = bad_generator.get_schema(None, True)
with self.assertRaises(codecs.SwaggerValidationError):
self.codec_json.encode(swagger)
def test_json_codec_roundtrip(self):
swagger = self.generator.get_schema(None, True)
json_bytes = self.codec_json.encode(swagger)
self._validate_schema(json.loads(json_bytes.decode('utf-8')))
def test_yaml_codec_roundtrip(self):
swagger = self.generator.get_schema(None, True)
json_bytes = self.codec_yaml.encode(swagger)
self._validate_schema(yaml.safe_load(json_bytes.decode('utf-8')))
class SchemaTest(TestCase):
def setUp(self):
self.generator = OpenAPISchemaGenerator(
info=openapi.Info("Test generator", "v1"),
version="v2",
)
self.codec_json = codecs.OpenAPICodecJson(['flex', 'ssv'])
self.codec_yaml = codecs.OpenAPICodecYaml(['ssv', 'flex'])
self.swagger = self.generator.get_schema(None, True)
json_bytes = self.codec_yaml.encode(self.swagger)
self.swagger_dict = yaml.safe_load(json_bytes.decode('utf-8'))
def test_paths_not_empty(self):
self.assertTrue(bool(self.swagger_dict['paths']))
def test_appropriate_status_codes(self):
snippets_list = self.swagger_dict['paths']['/snippets/']
self.assertTrue('200' in snippets_list['get']['responses'])
self.assertTrue('201' in snippets_list['post']['responses'])
snippets_detail = self.swagger_dict['paths']['/snippets/{id}/']
self.assertTrue('200' in snippets_detail['get']['responses'])
self.assertTrue('200' in snippets_detail['put']['responses'])
self.assertTrue('200' in snippets_detail['patch']['responses'])
self.assertTrue('204' in snippets_detail['delete']['responses'])
def test_operation_docstrings(self):
snippets_list = self.swagger_dict['paths']['/snippets/']
self.assertEqual(snippets_list['get']['description'], "SnippetList classdoc")
self.assertEqual(snippets_list['post']['description'], "post method docstring")
snippets_detail = self.swagger_dict['paths']['/snippets/{id}/']
self.assertEqual(snippets_detail['get']['description'], "SnippetDetail classdoc")
self.assertEqual(snippets_detail['put']['description'], "put class docstring")
self.assertEqual(snippets_detail['patch']['description'], "patch method docstring")
self.assertEqual(snippets_detail['delete']['description'], "delete method docstring")
testproj/testproj/urls.py
+9 -7
View File
@@ -1,10 +1,10 @@
from django.conf.urls import url, include
from django.contrib import admin
from drf_swagger.views import get_schema_view
from drf_swagger import openapi
from rest_framework import permissions
from drf_swagger import openapi
from drf_swagger.views import get_schema_view
schema_view = get_schema_view(
openapi.Info(
title="Snippets API",
@@ -14,16 +14,18 @@ schema_view = get_schema_view(
contact=openapi.Contact(email="contact@snippets.local"),
license=openapi.License(name="BSD License"),
),
validators=['flex', 'ssv'],
public=False,
validators=['ssv', 'flex'],
public=True,
permission_classes=(permissions.AllowAny,),
)
urlpatterns = [
url(r'^swagger(?P<format>.json|.yaml)$', schema_view.without_ui(cache_timeout=None), name='schema-json'),
url(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=None), name='schema-swagger-ui'),
url(r'^swagger(?P<format>.json|.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),
url(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
url(r'^redoc/$', schema_view.with_ui('redoc', cache_timeout=None), name='schema-redoc'),
url(r'^admin/', admin.site.urls),
url(r'^snippets/', include('snippets.urls')),
url(r'^articles/', include('articles.urls')),
url(r'^users/', include('users.urls')),
]