Skip to content

Commit 4e85773

Browse files
committed
Update 3.9 announcement
1 parent 2deb6b4 commit 4e85773

File tree

1 file changed

+44
-7
lines changed

1 file changed

+44
-7
lines changed

Diff for: docs/community/3.9-announcement.md

+44-7
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
# Django REST framework 3.9
2121

22-
The 3.9 release gives access to _extra actions_ in the Browsable API, introduces composable permissions and built-in [OpenAPI][openapi] schema support.
22+
The 3.9 release gives access to _extra actions_ in the Browsable API, introduces composable permissions and built-in [OpenAPI][openapi] schema support. (Formerly known as Swagger)
2323

2424
---
2525

@@ -45,9 +45,9 @@ If you use REST framework commercially and would like to see this work continue,
4545

4646
---
4747

48-
## In-built OpenAPI schema support
48+
## Built-in OpenAPI schema support
4949

50-
REST framework now has a first-pass at directly including OpenAPI schema support.
50+
REST framework now has a first-pass at directly including OpenAPI schema support. (Formerly known as Swagger)
5151

5252
Specifically:
5353

@@ -77,10 +77,31 @@ urlpatterns = [
7777

7878
And here's how you can use the `generateschema` management command:
7979

80-
```
80+
```shell
8181
$ python manage.py generateschema --format openapi > schema.yml
8282
```
8383

84+
There's lots of different tooling that you can use for working with OpenAPI
85+
schemas. One option that we're working on is the [API Star](https://docs.apistar.com/)
86+
command line tool.
87+
88+
You can use `apistar` to validate your API schema:
89+
90+
```shell
91+
$ apistar validate --path schema.json --format openapi
92+
✓ Valid OpenAPI schema.
93+
```
94+
95+
Or to build API documentation:
96+
97+
```shell
98+
$ apistar docs --path schema.json --format openapi
99+
✓ Documentation built at "build/index.html".
100+
```
101+
102+
API Star also includes a [dynamic client library](https://docs.apistar.com/client-library/)
103+
that uses an API schema to automatically provide a client library interface for making requests.
104+
84105
## Composable permission classes
85106

86107
You can now compose permission classes using the and/or operators, `&` and `|`.
@@ -105,6 +126,12 @@ When defined, a dropdown of "Extra Actions", appropriately filtered to detail/no
105126

106127
---
107128

129+
## Supported Versions
130+
131+
REST framework 3.9 supports Django versions 1.11, 2.0, and 2.1.
132+
133+
---
134+
108135
## Deprecations
109136

110137
### `DjangoObjectPermissionsFilter` moved to third-party package.
@@ -164,9 +191,19 @@ OpenAPI functionality.
164191

165192
This will also make a wider range of tooling available.
166193

167-
We'll focus on continuing to develop the `apistar` library and client tool into
168-
a recommended option for generating API docs, validating API schemas, and
169-
providing a dynamic client library.
194+
We'll focus on continuing to develop the [API Star](https://docs.apistar.com/)
195+
library and client tool into a recommended option for generating API docs,
196+
validating API schemas, and providing a dynamic client library.
197+
198+
There's also a huge amount of ongoing work on maturing the ASGI landscape,
199+
with the possibility that some of this work will eventually [feed back into
200+
Django](https://www.aeracode.org/2018/06/04/django-async-roadmap/).
201+
202+
There will be further work on the [Uvicorn](https://www.uvicorn.org/)
203+
webserver, as well as lots of functionality planned for the [Starlette](https://www.starlette.io/)
204+
web framework, which is building a foundational set of tooling for working with
205+
ASGI.
206+
170207

171208
[funding]: funding.md
172209
[gh5886]: https://github.com/encode/django-rest-framework/issues/5886

0 commit comments

Comments
 (0)