From 4c78a683f492df83a8216dc8b8697a465ea48d0b Mon Sep 17 00:00:00 2001 From: Cristi Vijdea Date: Sun, 3 Mar 2019 23:59:12 +0200 Subject: [PATCH] Remove Background section from readme --- README.rst | 39 --------------------------------------- 1 file changed, 39 deletions(-) diff --git a/README.rst b/README.rst index 2f31292..5997f05 100644 --- a/README.rst +++ b/README.rst @@ -306,45 +306,6 @@ For additional usage examples, you can take a look at the test project in the `` (venv) $ python manage.py runserver (venv) $ firefox localhost:8000/swagger/ -********** -Background -********** - -``OpenAPI 2.0``/``Swagger`` is a format designed to encode information about a Web API into an easily parsable schema -that can then be used for rendering documentation, generating code, etc. - -More details are available on `swagger.io `__ and on the `OpenAPI 2.0 specification -page `__. - -From here on, the terms “OpenAPI” and “Swagger” are used interchangeably. - -Swagger in Django Rest Framework -================================ - -Since Django Rest Framework 3.7, there is now `built in support `__ -for automatic OpenAPI 2.0 schema generation. However, this generation is based on the `coreapi `__ -standard, which for the moment is vastly inferior to OpenAPI in both features and tooling support. In particular, -the OpenAPI codec/compatibility layer provided has a few major problems: - -* there is no support for documenting response schemas and status codes -* nested schemas do not work properly -* does not handle more complex fields such as ``FileField``, ``ChoiceField``, … - -In short this makes the generated schema unusable for code generation, and mediocre at best for documentation. - -Other libraries -=============== - -There are currently two decent Swagger schema generators that I could find for django-rest-framework: - -* `django-rest-swagger `__ -* `drf-openapi `__ - -``django-rest-swagger`` is just a wrapper around DRF 3.7 schema generation with an added UI, and -thus presents the same problems, while also being unmaintained. ``drf-openapi`` was -`discontinued by the author `_ -on April 3rd, 2018. - ************************ Third-party integrations ************************