Skip to content

Latest commit

 

History

History
111 lines (76 loc) · 2.78 KB

quickstart.rst

File metadata and controls

111 lines (76 loc) · 2.78 KB
Raw

Quickstart

Installation

Pre-requisites

  • Python 3.9 or higher
  • Setuptools 30.3.0 or higher
  • Only the PostgreSQL database is supported

Install from PyPI

Install from PyPI with pip:

pip install vng-api-common

You will also need the NPM package prettier:

npm install prettier

Configure the Django settings

  1. Add vng_api_common to INSTALLED_APPS, with the rest of the dependencies:

    INSTALLED_APPS = [
    ...,
    'django.contrib.sites',  # required if using the notifications

    'django_filters',
    'vng_api_common',  # before drf_yasg to override the management command
    'vng_api_common.authorizations',
    'vng_api_common.notifications',  # optional
    'vng_api_common.audittrails',  # optional
    'drf_spectacular',
    'rest_framework',
    'solo',  # required for authorizations and notifications
    ...
]

  2. Add the required middleware:

     MIDDLEWARE = [
     'django.middleware.security.SecurityMiddleware',
     'django.contrib.sessions.middleware.SessionMiddleware',
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
     'django.contrib.auth.middleware.AuthenticationMiddleware',
     'vng_api_common.middleware.AuthMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
     'vng_api_common.middleware.APIVersionHeaderMiddleware',
 ]

  3. Add the default API settings:

    from vng_api_common.conf.api import *  # noqa

...

    Imports are white-listed in the shipped settings module, so it's actually safe to do import * ;)

  4. See vng_api_common/conf/api.py for a list of available settings.

Usage

API Spec generation

To generate the API spec, run:

generate_schema

This will output:

  • src/openapi.yaml: the OAS 3 specification
  • src/resources.md: a list of the exposed resources

See the reference implementations of ZRC, DRC, BRC en ZTC to see it in action.

Run-time functionality

See the rest of the documentation for the available modules and packages.