Port details |
- py-dj42-drf-spectacular Sane/flexible OpenAPI 3 schema generation for Django REST framework
- 0.27.2 www =0 0.27.1Version of this port present on the latest quarterly branch.
- Maintainer: kai@FreeBSD.org
- Port Added: 2023-09-10 13:18:26
- Last Update: 2024-04-05 12:56:33
- Commit Hash: c1b6d8b
- Also Listed In: python
- License: BSD3CLAUSE
- WWW:
- https://github.com/tfranzel/drf-spectacular
- Description:
- This project has 3 goals:
* Extract as much schema information from DRF as possible.
* Provide flexibility to make the schema usable in the real world (not only
toy examples).
* Generate a schema that works well with the most popular client generators.
The code is a heavily modified fork of the DRF OpenAPI generator, which is/was
lacking all of the below listed features:
* Serializers modelled as components. (arbitrary nesting + recursion supported)
* @extend_schema decorator for customization of APIView, Viewsets,
function-based views, and @action
* Authentication support (DRF natives included, easily extendable)
* Custom serializer class support (easily extendable)
* SerializerMethodField() type via type hinting or @extend_schema_field
* i18n support, Tags extraction, Description extraction from docstrings
* Request/response/parameter examples, Callback operations
* Vendor specification extensions (x-*) in info, operations, parameters,
components, and security schemes
* Sane fallbacks and sane operation_id naming (based on path)
* Schema serving with SpectacularAPIView (Redoc and Swagger-UI views are
also available)
* Optional input/output serializer component split
- ¦ ¦ ¦ ¦
- Manual pages:
- FreshPorts has no man page information for this port.
- pkg-plist: as obtained via:
make generate-plist - There is no configure plist information for this port.
- Dependency lines:
-
- ${PYTHON_PKGNAMEPREFIX}dj42-drf-spectacular>0:www/py-dj42-drf-spectacular@${PY_FLAVOR}
- Conflicts:
- CONFLICTS_INSTALL:
- Conflicts Matches:
-
There are no Conflicts Matches for this port. This is usually an error.
- To install the port:
- cd /usr/ports/www/py-dj42-drf-spectacular/ && make install clean
- To add the package, run one of these commands:
- pkg install www/py-dj42-drf-spectacular
- pkg install py39-dj42-drf-spectacular
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above. NOTE: This is a Python port. Instead of py39-dj42-drf-spectacular listed in the above command, you can pick from the names under the Packages section.- PKGNAME: py39-dj42-drf-spectacular
- Package flavors (<flavor>: <package>)
- py39: py39-dj42-drf-spectacular
- distinfo:
- TIMESTAMP = 1712292804
SHA256 (drf-spectacular-0.27.2.tar.gz) = a199492f2163c4101055075ebdbb037d59c6e0030692fc83a1a8c0fc65929981
SIZE (drf-spectacular-0.27.2.tar.gz) = 235131
Packages (timestamps in pop-ups are UTC):
- Dependencies
- NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.
- Build dependencies:
-
- py39-setuptools>=63.1.0 : devel/py-setuptools@py39
- python3.9 : lang/python39
- Test dependencies:
-
- python3.9 : lang/python39
- Runtime dependencies:
-
- py39-django42>=2.2 : www/py-django42@py39
- py39-dj42-djangorestframework>=3.10.3 : www/py-dj42-djangorestframework@py39
- py39-inflection>=0.3.1 : devel/py-inflection@py39
- py39-jsonschema>=2.6.0 : devel/py-jsonschema@py39
- py39-uritemplate>=2.0.0 : net/py-uritemplate@py39
- py39-yaml>=5.1 : devel/py-yaml@py39
- py39-dj42-drf-spectacular-sidecar>0 : www/py-dj42-drf-spectacular-sidecar@py39
- py39-setuptools>=63.1.0 : devel/py-setuptools@py39
- python3.9 : lang/python39
- py39-typing-extensions>0 : devel/py-typing-extensions@py39
- This port is required by:
- for Run
-
- net-mgmt/netbox
Configuration Options:
- ===> The following configuration options are available for py39-dj42-drf-spectacular-0.27.2:
SIDECAR=on: Enable self-contained Swagger/Redoc UI installation
===> Use 'make config' to modify these settings
- Options name:
- www_py-dj42-drf-spectacular
- USES:
- python
- FreshPorts was unable to extract/find any pkg message
- Master Sites:
|