| Name | drf-spectacular-websocket JSON |
| Version |
1.3.0
JSON |
| download |
| home_page | https://github.com/Friskes/drf-spectacular-websocket |
| Summary | Extend websocket schema decorator for Django Channels |
| upload_time | 2024-10-23 15:38:20 |
| maintainer | None |
| docs_url | None |
| author | Friskes |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Friskes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
django
drf
spectacular
swagger
channels
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Extend websocket schema decorator for Django Channels
<div align="center">
| Project | | Status |
|-----------|:----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CI/CD | | [](https://github.com/Friskes/drf-spectacular-websocket/actions/workflows/publish-to-pypi.yml) |
| Quality | | [](https://codecov.io/github/Friskes/drf-spectacular-websocket) |
| Package | | [](https://badge.fury.io/py/drf-spectacular-websocket)   |
| Meta | | [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/astral-sh/ruff) |
</div>
> Provides [extend_ws_schema](#About-decorator) decorator to documentation [Cunsumer](https://channels.readthedocs.io/en/latest/topics/consumers.html) methods from [channels](https://github.com/django/channels) just like it does [drf-spectacular](https://github.com/tfranzel/drf-spectacular)
## Install
1. Install package
```bash
pip install drf-spectacular-websocket
```
2. Create sidecar static
```bash
python manage.py collectstatic
```
3. Add app name to `INSTALLED_APPS`
> `drf_spectacular_websocket` must be higher than `drf_spectacular`
```python
INSTALLED_APPS = [
'drf_spectacular_websocket',
'drf_spectacular',
'drf_spectacular_sidecar',
]
```
## Configure settings
```python
ASGI_APPLICATION = 'path.to.your.application'
# (Optional) this is default settings are automatically set by the drf_spectacular_websocket.
# You can override them in your application if necessary.
SPECTACULAR_SETTINGS = {
'DEFAULT_GENERATOR_CLASS': 'drf_spectacular_websocket.schemas.WsSchemaGenerator',
'SWAGGER_UI_DIST': 'SIDECAR',
'SWAGGER_UI_FAVICON_HREF': 'SIDECAR',
'REDOC_DIST': 'SIDECAR',
'SWAGGER_UI_SETTINGS': {
'connectSocket': True, # Automatically establish a WS connection when opening swagger
'socketMaxMessages': 8, # Max number of messages displayed in the log window in swagger
'socketMessagesInitialOpened': False, # Automatically open the log window when opening swagger
},
}
```
> drf_spectacular_websocket automatically finds websocket urls and related consumer using `ASGI_APPLICATION` setting.
## About decorator
`extend_ws_schema` decorator accepts one new `type` parameter relative to drf_spectacular `extend_schema`.
- possible values:
- `send` - Type of interaction, [request -> response]
- `receive` - Type of interaction, [response without request]
## Usage example
```python
from channels.generic.websocket import AsyncJsonWebsocketConsumer
from rest_framework.serializers import Serializer, CharField
from drf_spectacular_websocket.decorators import extend_ws_schema
class SomeMethodInputSerializer(Serializer):
some_field = CharField()
class SomeMethodOutputSerializer(Serializer):
some_field = CharField()
class SendMessageOutputSerializer(Serializer):
some_field = CharField()
class SomeConsumer(AsyncJsonWebsocketConsumer):
async def receive_json(self, content, **kwargs):
some_value = content.get('some_key')
if some_value:
await self.some_method(some_value)
@extend_ws_schema(
type='send',
summary='some_method_summary',
description='some_method_description',
request=SomeMethodInputSerializer,
responses=SomeMethodOutputSerializer,
)
async def some_method(self, some_value):
input_serializer = SomeMethodInputSerializer(data=some_value)
input_serializer.is_valid(raise_exception=True)
return_value = await some_business_logic(input_serializer.validated_data)
output_serializer = SomeMethodOutputSerializer(data=return_value)
output_serializer.is_valid(raise_exception=True)
await self.send_json(output_serializer.validated_data)
@extend_ws_schema(
type='receive',
summary='send_message_summary',
description='send_message_description',
request=None,
responses=SendMessageOutputSerializer,
)
async def send_message(self, message):
await self.send_json(message)
```
## Contributing
We would love you to contribute to `drf-spectacular-websocket`, pull requests are very welcome! Please see [CONTRIBUTING.md](https://github.com/Friskes/drf-spectacular-websocket/blob/main/CONTRIBUTING.md) for more information.
## Swagger Examples
### Send
### Receive
Raw data
{
"_id": null,
"home_page": "https://github.com/Friskes/drf-spectacular-websocket",
"name": "drf-spectacular-websocket",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Django, DRF, Spectacular, Swagger, Channels",
"author": "Friskes",
"author_email": "Friskes <friskesx@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/85/72/bcd8aade473b9977f90a4fb5c330d9079f8a955871141337dc5a73d4d3d2/drf_spectacular_websocket-1.3.0.tar.gz",
"platform": null,
"description": "# Extend websocket schema decorator for Django Channels\n\n<div align=\"center\">\n\n| Project | | Status |\n|-----------|:----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| CI/CD | | [](https://github.com/Friskes/drf-spectacular-websocket/actions/workflows/publish-to-pypi.yml) |\n| Quality | | [](https://codecov.io/github/Friskes/drf-spectacular-websocket) |\n| Package | | [](https://badge.fury.io/py/drf-spectacular-websocket)   |\n| Meta | | [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/astral-sh/ruff) |\n\n</div>\n\n> Provides [extend_ws_schema](#About-decorator) decorator to documentation [Cunsumer](https://channels.readthedocs.io/en/latest/topics/consumers.html) methods from [channels](https://github.com/django/channels) just like it does [drf-spectacular](https://github.com/tfranzel/drf-spectacular)\n\n\n## Install\n1. Install package\n ```bash\n pip install drf-spectacular-websocket\n ```\n\n2. Create sidecar static\n ```bash\n python manage.py collectstatic\n ```\n\n3. Add app name to `INSTALLED_APPS`\n > `drf_spectacular_websocket` must be higher than `drf_spectacular`\n ```python\n INSTALLED_APPS = [\n 'drf_spectacular_websocket',\n 'drf_spectacular',\n 'drf_spectacular_sidecar',\n ]\n ```\n\n\n## Configure settings\n```python\nASGI_APPLICATION = 'path.to.your.application'\n\n# (Optional) this is default settings are automatically set by the drf_spectacular_websocket.\n# You can override them in your application if necessary.\nSPECTACULAR_SETTINGS = {\n 'DEFAULT_GENERATOR_CLASS': 'drf_spectacular_websocket.schemas.WsSchemaGenerator',\n 'SWAGGER_UI_DIST': 'SIDECAR',\n 'SWAGGER_UI_FAVICON_HREF': 'SIDECAR',\n 'REDOC_DIST': 'SIDECAR',\n 'SWAGGER_UI_SETTINGS': {\n 'connectSocket': True, # Automatically establish a WS connection when opening swagger\n 'socketMaxMessages': 8, # Max number of messages displayed in the log window in swagger\n 'socketMessagesInitialOpened': False, # Automatically open the log window when opening swagger\n },\n}\n```\n\n> drf_spectacular_websocket automatically finds websocket urls and related consumer using `ASGI_APPLICATION` setting.\n\n## About decorator\n`extend_ws_schema` decorator accepts one new `type` parameter relative to drf_spectacular `extend_schema`.\n- possible values:\n - `send` - Type of interaction, [request -> response]\n - `receive` - Type of interaction, [response without request]\n\n## Usage example\n\n```python\nfrom channels.generic.websocket import AsyncJsonWebsocketConsumer\nfrom rest_framework.serializers import Serializer, CharField\nfrom drf_spectacular_websocket.decorators import extend_ws_schema\n\n\nclass SomeMethodInputSerializer(Serializer):\n some_field = CharField()\n\n\nclass SomeMethodOutputSerializer(Serializer):\n some_field = CharField()\n\n\nclass SendMessageOutputSerializer(Serializer):\n some_field = CharField()\n\n\nclass SomeConsumer(AsyncJsonWebsocketConsumer):\n\n async def receive_json(self, content, **kwargs):\n some_value = content.get('some_key')\n if some_value:\n await self.some_method(some_value)\n\n @extend_ws_schema(\n type='send',\n summary='some_method_summary',\n description='some_method_description',\n request=SomeMethodInputSerializer,\n responses=SomeMethodOutputSerializer,\n )\n async def some_method(self, some_value):\n input_serializer = SomeMethodInputSerializer(data=some_value)\n input_serializer.is_valid(raise_exception=True)\n\n return_value = await some_business_logic(input_serializer.validated_data)\n\n output_serializer = SomeMethodOutputSerializer(data=return_value)\n output_serializer.is_valid(raise_exception=True)\n\n await self.send_json(output_serializer.validated_data)\n\n @extend_ws_schema(\n type='receive',\n summary='send_message_summary',\n description='send_message_description',\n request=None,\n responses=SendMessageOutputSerializer,\n )\n async def send_message(self, message):\n await self.send_json(message)\n```\n\n## Contributing\nWe would love you to contribute to `drf-spectacular-websocket`, pull requests are very welcome! Please see [CONTRIBUTING.md](https://github.com/Friskes/drf-spectacular-websocket/blob/main/CONTRIBUTING.md) for more information.\n\n## Swagger Examples\n\n### Send\n\n\n### Receive\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Friskes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Extend websocket schema decorator for Django Channels",
"version": "1.3.0",
"project_urls": {
"Changelog": "https://github.com/Friskes/drf-spectacular-websocket/releases/",
"Homepage": "https://github.com/Friskes/drf-spectacular-websocket",
"Issues": "https://github.com/Friskes/drf-spectacular-websocket/issues"
},
"split_keywords": [
"django",
" drf",
" spectacular",
" swagger",
" channels"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df4a0ca96d6dbb9c07884ab7de5379bdbdf2083ee5aefe5c1206afc332e92d46",
"md5": "66c88b411a31d4dc8a3b842234f01e18",
"sha256": "9f1bc609cf78b96d19073347a13374ebc7c0cf97f39ccbd68be871ed9108d3e1"
},
"downloads": -1,
"filename": "drf_spectacular_websocket-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "66c88b411a31d4dc8a3b842234f01e18",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16731,
"upload_time": "2024-10-23T15:38:19",
"upload_time_iso_8601": "2024-10-23T15:38:19.127448Z",
"url": "https://files.pythonhosted.org/packages/df/4a/0ca96d6dbb9c07884ab7de5379bdbdf2083ee5aefe5c1206afc332e92d46/drf_spectacular_websocket-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8572bcd8aade473b9977f90a4fb5c330d9079f8a955871141337dc5a73d4d3d2",
"md5": "695a2ff46af8ad57ab8b606624eb55ce",
"sha256": "bee5e564eaf98946ef839d9165ab92fb26cae36fd7a4e497d1c4c5da5b8e7ed4"
},
"downloads": -1,
"filename": "drf_spectacular_websocket-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "695a2ff46af8ad57ab8b606624eb55ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 163619,
"upload_time": "2024-10-23T15:38:20",
"upload_time_iso_8601": "2024-10-23T15:38:20.924889Z",
"url": "https://files.pythonhosted.org/packages/85/72/bcd8aade473b9977f90a4fb5c330d9079f8a955871141337dc5a73d4d3d2/drf_spectacular_websocket-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 15:38:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Friskes",
"github_project": "drf-spectacular-websocket",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "drf-spectacular-websocket"
}
