Skip to content

Documented how to add DJA to installed apps #963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 26, 2021
Merged

Documented how to add DJA to installed apps #963

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b1474e
Documented how to add DJA to installed apps
sliverc Jul 20, 2021
8c1a624
Merge branch 'master' into installed_apps_setting
n2ygk Jul 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,7 @@ Generally Python and Django series are supported till the official end of life.
Installation
------------

From PyPI
^^^^^^^^^
Install using ``pip``...

::

Expand All @@ -112,8 +111,7 @@ From PyPI
$ pip install djangorestframework-jsonapi['openapi']


From Source
^^^^^^^^^^^
or from source...

::

Expand All @@ -122,6 +120,18 @@ From Source
$ pip install -e .


and add ``rest_framework_json_api`` to your ``INSTALLED_APPS`` setting below ``rest_framework``.

::

INSTALLED_APPS = [
...
'rest_framework',
'rest_framework_json_api',
...
]


Running the example app
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
14 changes: 12 additions & 2 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,29 @@ Generally Python and Django series are supported till the official end of life.

## Installation

From PyPI
Install using `pip`...

pip install djangorestframework-jsonapi
# for optional package integrations
pip install djangorestframework-jsonapi['django-filter']
pip install djangorestframework-jsonapi['django-polymorphic']
pip install djangorestframework-jsonapi['openapi']

From Source
or from source...

git clone https://github.com/django-json-api/django-rest-framework-json-api.git
cd django-rest-framework-json-api && pip install -e .


and add `rest_framework_json_api` to your `INSTALLED_APPS` setting below `rest_framework`.

INSTALLED_APPS = [
...
'rest_framework',
'rest_framework_json_api',
...
]

## Running the example app

git clone https://github.com/django-json-api/django-rest-framework-json-api.git
Expand Down
2 changes: 1 addition & 1 deletion docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -998,7 +998,7 @@ The `prefetch_related` case will issue 4 queries, but they will be small and fas

## Generating an OpenAPI Specification (OAS) 3.0 schema document

DRF >= 3.12 has a [new OAS schema functionality](https://www.django-rest-framework.org/api-guide/schemas/) to generate an
DRF has a [OAS schema functionality](https://www.django-rest-framework.org/api-guide/schemas/) to generate an
[OAS 3.0 schema](https://www.openapis.org/) as a YAML or JSON file.

DJA extends DRF's schema support to generate an OAS schema in the JSON:API format.
Expand Down