|
| 1 | +<style> |
| 2 | +.promo li a { |
| 3 | + float: left; |
| 4 | + width: 130px; |
| 5 | + height: 20px; |
| 6 | + text-align: center; |
| 7 | + margin: 10px 30px; |
| 8 | + padding: 150px 0 0 0; |
| 9 | + background-position: 0 50%; |
| 10 | + background-size: 130px auto; |
| 11 | + background-repeat: no-repeat; |
| 12 | + font-size: 120%; |
| 13 | + color: black; |
| 14 | +} |
| 15 | +.promo li { |
| 16 | + list-style: none; |
| 17 | +} |
| 18 | +</style> |
1 | 19 |
|
2 | 20 | # Django REST framework 3.10
|
3 | 21 |
|
4 |
| -## Python 3 Only. |
5 |
| - |
6 |
| -The 3.10 release is our first to drop support for Python 2. |
| 22 | +The 3.10 release drops support for Python 2. |
7 | 23 |
|
8 |
| -Our supported Python versions are currently 3.5, 3.6, and 3.7. |
| 24 | +* Our supported Python versions are now: 3.5, 3.6, and 3.7. |
| 25 | +* Our supported Django versions are now: 1.11, 2.0, 2.1, and 2.2. |
9 | 26 |
|
10 |
| -Our support Django versions are currently 1.11, 2.0, 2.1, and 2.2. |
11 |
| - |
12 |
| -## OpenAPI Schema Generation. |
| 27 | +## OpenAPI Schema Generation |
13 | 28 |
|
14 | 29 | Since we first introduced schema support in Django REST Framework 3.5, OpenAPI has emerged as the widely adopted standard for modeling Web APIs.
|
15 | 30 |
|
@@ -39,35 +54,9 @@ from REST framework, scheduled for version 3.12.
|
39 | 54 | We have removed the old documentation for the CoreAPI based schema generation.
|
40 | 55 | You may view the [Legacy CoreAPI documentation here][legacy-core-api-docs].
|
41 | 56 |
|
42 |
| ---- |
43 |
| - |
44 |
| -**Switching mode between `CoreAPI` and `OpenAPI`** |
45 |
| - |
46 |
| -Both the `generateschema` management command and `get_schema_view()` helper |
47 |
| -function will automatically switch between `CoreAPI` and `OpenAPI` modes, |
48 |
| -depending on the value of `api_settings.DEFAULT_SCHEMA_CLASS`. |
49 |
| - |
50 |
| -If `api_settings.DEFAULT_SCHEMA_CLASS` is a subclass of |
51 |
| -`rest_framework.schemas.coreapi.AutoSchema` then `CoreAPI` mode will be |
52 |
| -selected. Otherwise the new `OpenAPI` will apply. |
53 |
| - |
54 |
| -This means that, unless you previously overrode |
55 |
| -`api_settings.DEFAULT_SCHEMA_CLASS`, you automatically be opted-in to the new |
56 |
| -`OpenAPI` based schemas. |
57 |
| - |
58 |
| -You can continue to use CoreAPI schemas by setting the appropriate default |
59 |
| -schema class: |
60 |
| - |
61 |
| -```python |
62 |
| -# In settings.py |
63 |
| -REST_FRAMEWORK = { |
64 |
| - 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema', |
65 |
| -} |
66 |
| -``` |
67 |
| - |
68 | 57 | ----
|
69 | 58 |
|
70 |
| -## Quickstart |
| 59 | +## OpenAPI Quickstart |
71 | 60 |
|
72 | 61 | You can generate a static OpenAPI schema, using the `generateschema` management
|
73 | 62 | command.
|
@@ -130,4 +119,29 @@ tooling that are driven by the OpenAPI schema. The `apistar` project has a
|
130 | 119 | significant amount of work towards this. However, if we do so, we'll plan
|
131 | 120 | on keeping any tooling outside of the core framework.
|
132 | 121 |
|
| 122 | +--- |
| 123 | + |
| 124 | +## Funding |
| 125 | + |
| 126 | +REST framework is a *collaboratively funded project*. If you use |
| 127 | +REST framework commercially we strongly encourage you to invest in its |
| 128 | +continued development by **[signing up for a paid plan][funding]**. |
| 129 | + |
| 130 | +*Every single sign-up helps us make REST framework long-term financially sustainable.* |
| 131 | + |
| 132 | +<ul class="premium-promo promo"> |
| 133 | + <li><a href="https://getsentry.com/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li> |
| 134 | + <li><a href="https://getstream.io/try-the-api/?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> |
| 135 | + <li><a href="https://software.esg-usa.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/esg-new-logo.png)">ESG</a></li> |
| 136 | + <li><a href="https://rollbar.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rollbar2.png)">Rollbar</a></li> |
| 137 | + <li><a href="https://cadre.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/cadre.png)">Cadre</a></li> |
| 138 | + <li><a href="https://hubs.ly/H0f30Lf0" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/kloudless-plus-text.png)">Kloudless</a></li> |
| 139 | + <li><a href="https://lightsonsoftware.com" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/lightson-dark.png)">Lights On Software</a></li> |
| 140 | +</ul> |
| 141 | +<div style="clear: both; padding-bottom: 20px;"></div> |
| 142 | + |
| 143 | +*Many thanks to all our [wonderful sponsors][sponsors], and in particular to our premium backers, [Sentry](https://getsentry.com/welcome/), [Stream](https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf), [ESG](https://software.esg-usa.com/), [Rollbar](https://rollbar.com/?utm_source=django&utm_medium=sponsorship&utm_campaign=freetrial), [Cadre](https://cadre.com), [Kloudless](https://hubs.ly/H0f30Lf0), and [Lights On Software](https://lightsonsoftware.com).* |
| 144 | + |
133 | 145 | [legacy-core-api-docs]:https://github.com/encode/django-rest-framework/blob/master/docs/coreapi/index.md
|
| 146 | +[sponsors]: https://fund.django-rest-framework.org/topics/funding/#our-sponsors |
| 147 | +[funding]: community/funding.md |
0 commit comments