#### Code Based API document builder
# Overview
- Django Rest Framework (DRF)
- Code Based (Serializer to Docs)
- Swagger UI (https://swagger.io/swagger-ui/)
# Example
```python
from django.http import HttpResponse
from django.contrib.auth.models import User
from rest_framework import viewsets, serializers
from drf_swagger import drf_request, drf_response
class ViewSetTest(viewsets.ViewSet):
lookup_field = 'view_set'
@drf_request(RootSerializer)
@drf_response(RootSerializer)
def update(self, request, view_set):
"""
summary: test summary
parameters:
- name: test_param
in: query
type: string
description: Only 'name, in, type' is required
example: test example
required: true
"""
return HttpResponse("!@3123")
class RootSerializer(serializers.ModelSerializer):
id = serializers.CharField(
help_text='user pk: 46887',
required=True
)
class Meta:
model = User
fields = (
'email',
'id'
)
```
![example-img]
# Install
# Quick Start
# Warning
- For security, override SwaggerView and add login
- Will Make login/security setting someday...
[example-img]: https://github.com/koyouhun/drf_swagger/blob/master/img/web.png?raw=true
Metadata
Release files for pip-test-swagger 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pip_test_swagger-0.1.3.tar.gz | 4.1 MB | Without provenance | Details for pip_test_swagger-0.1.3.tar.gz |
Release files / pip_test_swagger-0.1.3.tar.gz
| Download URL | pip_test_swagger-0.1.3.tar.gz |
|---|---|
| Size | 4.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
858e3e36d277790d092aa336f35c4a693fcb65794d84b53c2a3f80d79f4782bf
|
|
BLAKE2b-256 checksum How to use checksums |
9b7f53830a829a5d964cbd22eb61fa7dbdd714e97414ff77f9359c02459c895e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for pip-test-swagger 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.