Inspector for add example in drf-yasg docs
Project description
Add example value on your swagger documentation!
Requirements
- Python 3.6.1 or higher
- 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for drf_yasg_examples-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1d6a28cd0b36777417ba10c12e9f7bf90d84ca1a36e434bf127e8c37730b2ba |
|
MD5 | 16581aed4f2a80857c24cf7f7650d9c6 |
|
BLAKE2-256 | 1dece65673178d25a35a4d8a980378061305fae91171fcd30fd61154e0c71955 |