Permalink
Browse files

Version 3.5.0 (#4596)

  • Loading branch information...
1 parent 2395fb5 commit 3b9afb571b6e7c2a445be675163c9f43d680d899 @tomchristie committed on GitHub Oct 20, 2016
@@ -344,12 +344,12 @@ Typically you'll instantiate `SchemaGenerator` with a single argument, like so:
Arguments:
-* `title` - The name of the API. **required**
+* `title` **required** - The name of the API.
* `url` - The root URL of the API schema. This option is not required unless the schema is included under path prefix.
* `patterns` - A list of URLs to inspect when generating the schema. Defaults to the project's URL conf.
* `urlconf` - A URL conf module name to use when generating the schema. Defaults to `settings.ROOT_URLCONF`.
-### get_schema()
+### get_schema(self, request)
Returns a `coreapi.Document` instance that represents the API schema.
@@ -359,9 +359,48 @@ Returns a `coreapi.Document` instance that represents the API schema.
generator = schemas.SchemaGenerator(title='Bookings API')
return Response(generator.get_schema())
-Arguments:
+The `request` argument is optional, and may be used if you want to apply per-user
+permissions to the resulting schema generation.
+
+### get_links(self, request)
+
+Return a nested dictionary containing all the links that should be included in the API schema.
+
+This is a good point to override if you want to modify the resulting structure of the generated schema,
+as you can build a new dictionary with a different layout.
+
+### get_link(self, path, method, view)
+
+Returns a `coreapi.Link` instance corresponding to the given view.
+
+You can override this if you need to provide custom behaviors for particular views.
+
+### get_description(self, path, method, view)
+
+Returns a string to use as the link description. By default this is based on the
+view docstring as described in the "Schemas as Documentation" section above.
+
+### get_encoding(self, path, method, view)
+
+Returns a string to indicate the encoding for any request body, when interacting
+with the given view. Eg. `'application/json'`. May return a blank string for views
+that do not expect a request body.
+
+### get_path_fields(self, path, method, view):
+
+Return a list of `coreapi.Link()` instances. One for each path parameter in the URL.
+
+### get_serializer_fields(self, path, method, view)
+
+Return a list of `coreapi.Link()` instances. One for each field in the serializer class used by the view.
+
+### get_pagination_fields(self, path, method, view
+
+Return a list of `coreapi.Link()` instances, as returned by the `get_schema_fields()` method on any pagination class used by the view.
+
+### get_filter_fields(self, path, method, view)
-* `request` - The incoming request. Optionally used if you want to apply per-user permissions to the schema-generation.
+Return a list of `coreapi.Link()` instances, as returned by the `get_schema_fields()` method of any filter classes used by the view.
---
@@ -194,6 +194,7 @@ directly.
client = RequestsClient()
response = client.get('http://testserver/users/')
+ assert response.status_code == 200
Note that the requests client requires you to pass fully qualified URLs.
@@ -251,9 +252,8 @@ The CoreAPIClient allows you to interact with your API using the Python
`coreapi` client library.
# Fetch the API schema
- url = reverse('schema')
client = CoreAPIClient()
- schema = client.get(url)
+ schema = client.get('http://testserver/schema/')
# Create a new organisation
params = {'name': 'MegaCorp', 'status': 'active'}
View
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
@@ -244,6 +244,7 @@ General guides to using REST framework.
* [3.2 Announcement][3.2-announcement]
* [3.3 Announcement][3.3-announcement]
* [3.4 Announcement][3.4-announcement]
+* [3.5 Announcement][3.5-announcement]
* [Kickstarter Announcement][kickstarter-announcement]
* [Mozilla Grant][mozilla-grant]
* [Funding][funding]
@@ -370,6 +371,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
[3.2-announcement]: topics/3.2-announcement.md
[3.3-announcement]: topics/3.3-announcement.md
[3.4-announcement]: topics/3.4-announcement.md
+[3.5-announcement]: topics/3.5-announcement.md
[kickstarter-announcement]: topics/kickstarter-announcement.md
[mozilla-grant]: topics/mozilla-grant.md
[funding]: topics/funding.md
@@ -0,0 +1,266 @@
+<style>
+.promo li a {
+ float: left;
+ width: 130px;
+ height: 20px;
+ text-align: center;
+ margin: 10px 30px;
+ padding: 150px 0 0 0;
+ background-position: 0 50%;
+ background-size: 130px auto;
+ background-repeat: no-repeat;
+ font-size: 120%;
+ color: black;
+}
+.promo li {
+ list-style: none;
+}
+</style>
+
+# Django REST framework 3.5
+
+The 3.5 release is the second in a planned series that is addressing schema
+generation, hypermedia support, API client libraries, and finally realtime support.
+
+---
+
+## Funding
+
+The 3.5 release would not have been possible without our [collaborative funding model][funding].
+If you use REST framework commercially and would like to see this work continue,
+we strongly encourage you to invest in its continued development by
+**[signing up for a paid&nbsp;plan][funding]**.
+
+<ul class="premium-promo promo">
+ <li><a href="http://jobs.rover.com/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rover_130x130.png)">Rover.com</a></li>
+ <li><a href="https://getsentry.com/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
+ <li><a href="https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/stream-130.png)">Stream</a></li>
+ <li><a href="http://www.machinalis.com/#services" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/Machinalis130.png)">Machinalis</a></li>
+</ul>
+<div style="clear: both; padding-bottom: 20px;"></div>
+
+*Many thanks to all our [sponsors][sponsors], and in particular to our premium backers, [Rover](http://jobs.rover.com/), [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), and [Machinalis](http://www.machinalis.com/#services).*
+
+---
+
+## Improved schema generation
+
+Docstrings on views are now pulled through into schema definitions, allowing
+you to [use the schema definition to document your&nbsp;API][schema-docs].
+
+There is now also a shortcut function, `get_schema_view()`, which makes it easier to
+[adding schema views][schema-view] to your API.
+
+For example, to include a swagger schema to your API, you would do the following:
+
+* Run `pip install django-rest-swagger`.
+
+* Add `'rest_framework_swagger'` to your `INSTALLED_APPS` setting.
+
+* Include the schema view in your URL conf:
+
+```py
+from rest_framework.schemas import get_schema_view
+from rest_framework_swagger.renderers import OpenAPIRenderer, SwaggerUIRenderer
+
+schema_view = get_schema_view(
+ title='Example API',
+ renderer_classes=[OpenAPIRenderer, SwaggerUIRenderer]
+)
+
+urlpatterns = [
+ url(r'^swagger/$', schema_view),
+ ...
+]
+```
+
+There have been a large number of fixes to the schema generation. These should
+resolve issues for anyone using the latest version of the `django-rest-swagger`
+package.
+
+Some of these changes do affect the resulting schema structure,
+so if you're already using schema generation you should make sure to review
+[the deprecation notes](#deprecations), particularly if you're currently using
+a dynamic client library to interact with your API.
+
+Finally, we're also now exposing the schema generation as a
+[publicly documented API][schema-generation-api], allowing you to more easily
+override the behaviour.
+
+## Requests test client
+
+You can now test your project using the `requests` library.
+
+This exposes exactly the same interface as if you were using a standard
+requests session instance.
+
+ client = RequestsClient()
+ response = client.get('http://testserver/users/')
+ assert response.status_code == 200
+
+Rather than sending any HTTP requests to the network, this interface will
+coerce all outgoing requests into WSGI, and call into your application directly.
+
+## Core API client
+
+You can also now test your project by interacting with it using the `coreapi`
+client library.
+
+ # Fetch the API schema
+ client = CoreAPIClient()
+ schema = client.get('http://testserver/schema/')
+
+ # Create a new organisation
+ params = {'name': 'MegaCorp', 'status': 'active'}
+ client.action(schema, ['organisations', 'create'], params)
+
+ # Ensure that the organisation exists in the listing
+ data = client.action(schema, ['organisations', 'list'])
+ assert(len(data) == 1)
+ assert(data == [{'name': 'MegaCorp', 'status': 'active'}])
+
+Again, this will call directly into the application using the WSGI interface,
+rather than making actual network calls.
+
+This is a good option if you are planning for clients to mainly interact with
+your API using the `coreapi` client library, or some other auto-generated client.
+
+## Live tests
+
+One interesting aspect of both the `requests` client and the `coreapi` client
+is that they allow you to write tests in such a way that they can also be made
+to run against a live service.
+
+By switching the WSGI based client instances to actual instances of `requests.Session`
+or `coreapi.Client` you can have the test cases make actual network calls.
+
+Being able to write test cases that can exercise your staging or production
+environment is a powerful tool. However in order to do this, you'll need to pay
+close attention to how you handle setup and teardown to ensure a strict isolation
+of test data from other live or staging data.
+
+## RAML support
+
+We now have preliminary support for [RAML documentation generation][django-rest-raml].
+
+![RAML Example][raml-image]
+
+Further work on the encoding and documentation generation is planned, in order to
+make features such as the 'Try it now' support available at a later date.
+
+This work also now means that you can use the Core API client libraries to interact
+with APIs that expose a RAML specification. The [RAML codec][raml-codec] gives some examples of
+interacting with the Spotify API in this way.
+
+## Validation codes
+
+Exceptions raised by REST framework now include short code identifiers.
+When used together with our customizable error handling, this now allows you to
+modify the style of API error messages.
+
+As an example, this allows for the following style of error responses:
+
+ {
+ "message": "You do not have permission to perform this action.",
+ "code": "permission_denied"
+ }
+
+This is particularly useful with validation errors, which use appropriate
+codes to identify differing kinds of failure...
+
+ {
+ "name": {"message": "This field is required.", "code": "required"},
+ "age": {"message": "A valid integer is required.", "code": "invalid"}
+ }
+
+## Client upload & download support
+
+The Python `coreapi` client library and the Core API command line tool both
+now fully support file [uploads][uploads] and [downloads][downloads].
+
+---
+
+## Deprecations
+
+### Generating schemas from Router
+
+The router arguments for generating a schema view, such as `schema_title`,
+are now pending deprecation.
+
+Instead of using `DefaultRouter(schema_title='Example API')`, you should use
+the `get_schema_view()` function, and include the view in your URL conf.
+
+Make sure to include the view before your router urls. For example:
+
+ from rest_framework.schemas import get_schema_view
+ from my_project.routers import router
+
+ schema_view = get_schema_view(title='Example API')
+
+ urlpatterns = [
+ url('^$', schema_view),
+ url(r'^', include(router.urls)),
+ ]
+
+### Schema path representations
+
+The `'pk'` identifier in schema paths is now mapped onto the actually model field
+name by default. This will typically be `'id'`.
+
+This gives a better external representation for schemas, with less implementation
+detail being exposed. It also reflects the behaviour of using a ModelSerializer
+class with `fields = '__all__'`.
+
+You can revert to the previous behaviour by setting `'SCHEMA_COERCE_PATH_PK': False`
+in the REST framework settings.
+
+### Schema action name representations
+
+The internal `retrieve()` and `destroy()` method names are now coerced to an
+external representation of `read` and `delete`.
+
+You can revert to the previous behaviour by setting `'SCHEMA_COERCE_METHOD_NAMES': {}`
+in the REST framework settings.
+
+### DjangoFilterBackend
+
+The functionality of the built-in `DjangoFilterBackend` is now completely
+included by the `django-filter` package.
+
+You should change your imports and REST framework filter settings as follows:
+
+* `rest_framework.filters.DjangoFilterBackend` becomes `django_filters.rest_framework.DjangoFilterBackend`.
+* `rest_framework.filters.FilterSet` becomes `django_filters.rest_framework.FilterSet`.
+
+The existing imports will continue to work but are now pending deprecation.
+
+### CoreJSON media type
+
+The media type for `CoreJSON` is now `application/json+coreapi`, rather than
+the previous `application/vnd.json+coreapi`. This brings it more into line with
+other custom media types, such as those used by Swagger and RAML.
+
+The clients currently accept either media type. The old style-media type will
+be deprecated at a later date.
+
+### ModelSerializer 'fields' and 'exclude'
+
+ModelSerializer and HyperlinkedModelSerializer must include either a fields
+option, or an exclude option. The fields = '__all__' shortcut may be used to
+explicitly include all fields.
+
+Failing to set either `fields` or `exclude` raised a pending deprecation warning
+in version 3.3 and raised a deprecation warning in 3.4. Its usage is now mandatory.
+
+---
+
+[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors
+[funding]: funding.md
+[uploads]: http://core-api.github.io/python-client/api-guide/utils/#file
+[downloads]: http://core-api.github.io/python-client/api-guide/codecs/#downloadcodec
+[schema-generation-api]: ../api-guide/schemas/#schemagenerator
+[schema-docs]: ../api-guide/schemas/#schemas-as-documentation
+[schema-view]: ../api-guide/schemas/#the-get_schema_view-shortcut
+[django-rest-raml]: https://github.com/tomchristie/django-rest-raml
+[raml-image]: ../img/raml.png
+[raml-codec]: https://github.com/core-api/python-raml-codec
@@ -257,7 +257,7 @@ Codecs are responsible for encoding or decoding Documents.
The decoding process is used by a client to take a bytestring of an API schema
definition, and returning the Core API `Document` that represents that interface.
-A codec should be associated with a particular media type, such as **TODO**.
+A codec should be associated with a particular media type, such as `'application/coreapi+json'`.
This media type is used by the server in the response `Content-Type` header,
in order to indicate what kind of data is being returned in the response.
@@ -38,6 +38,14 @@ You can determine your currently installed version using `pip freeze`:
---
+## 3.5.x series
+
+### 3.5.0
+
+**Date**: [20th October 2016][3.5.0-milestone]
+
+---
+
## 3.4.x series
### 3.4.7
@@ -596,6 +604,7 @@ For older release notes, [please see the version 2.x documentation][old-release-
[3.4.5-milestone]: https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.4.5+Release%22
[3.4.6-milestone]: https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.4.6+Release%22
[3.4.7-milestone]: https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.4.7+Release%22
+[3.5.0-milestone]: https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.5.0+Release%22
<!-- 3.0.1 -->
[gh2013]: https://github.com/tomchristie/django-rest-framework/issues/2013
Oops, something went wrong.

0 comments on commit 3b9afb5

Please sign in to comment.