Skip to main content

Inspector for add example in drf-yasg docs

Project description

Add example value on your swagger documentation!

Requirements

  1. Python 3.6.1 or higher
  2. drf-yasg based code base

Install

With pip

pip install drf-yasg-examples

With Poetry

poetry add drf-yasg-examples

Configuration

Edit your django config file.

SWAGGER_SETTINGS = {
    'DEFAULT_AUTO_SCHEMA_CLASS': 'drf_yasg_examples.SwaggerAutoSchema',
}

Note: If you use SwaggerAutoSchema class other codes, replace them together

Usage

ChoiceField

Just write verbose text like this in your models.

class Product(models.Model):

    CATEGORY = [
        ('F', 'Food'),
        ('L', 'Living Item'),
    ]

    category = models.CharField(
        verbose_name='Category',
        max_length=1,
        choices=CATEGORY,
    )

And ModelSerializer might set this field as ChoiceField, and this package write down enum k-v list on your documentation automatically.

Others

Write example value in your serializer class like this.

class ProductSerializer(serializers.ModelSerializer):

    class Meta:
        model = Product
        fields = '__all__'
        example = {
            'name': 'Apple',
            'amount': 6,
            'price': '10.00',
        }

Then drf-yasg will add example on your docs automatically.

LICENSE

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for drf-yasg-examples, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size drf_yasg_examples-0.1.1-py3-none-any.whl (3.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size drf-yasg-examples-0.1.1.tar.gz (3.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page