{"id":14986520,"url":"https://github.com/open-byte/djestful-framework","last_synced_at":"2025-04-11T21:31:26.394Z","repository":{"id":230776845,"uuid":"762799433","full_name":"open-byte/djestful-framework","owner":"open-byte","description":"RESTFul Framework for Django , autogenerate documentation with OpenAPI","archived":false,"fork":false,"pushed_at":"2025-03-30T07:10:28.000Z","size":172,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T07:27:24.223Z","etag":null,"topics":["api","django","django-rest-framework","generator-schema","open-api","open-source","openapi","pydantic","python","rest-framework","swagger","swagger-ui"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-byte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-24T18:12:52.000Z","updated_at":"2025-03-29T23:11:34.000Z","dependencies_parsed_at":"2024-07-13T08:33:48.648Z","dependency_job_id":"25acf4b2-da28-4787-8a4e-46d6ff0e96a1","html_url":"https://github.com/open-byte/djestful-framework","commit_stats":{"total_commits":4,"total_committers":1,"mean_commits":4.0,"dds":0.0,"last_synced_commit":"f164cb6aa633a520066df01a08bc3157100a50df"},"previous_names":["open-byte/djestful-framework"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-byte%2Fdjestful-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-byte%2Fdjestful-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-byte%2Fdjestful-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-byte%2Fdjestful-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-byte","download_url":"https://codeload.github.com/open-byte/djestful-framework/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248482947,"owners_count":21111406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","django","django-rest-framework","generator-schema","open-api","open-source","openapi","pydantic","python","rest-framework","swagger","swagger-ui"],"created_at":"2024-09-24T14:13:04.786Z","updated_at":"2025-04-11T21:31:26.058Z","avatar_url":"https://github.com/open-byte.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DjestFul Framework\n\nDjestFul is a framework which has the advantage of documenting the endpoints (views) of Django applications.\n\nIt is inspired by FastAPI, Django Ninja, and Django Restframework.\n\n\nThe main goal of DjestFul is to provide a simple way to document the endpoints of Django applications with the style of Django and FastAPI or Django Ninja.\n\nFor example, the following code is a simple Django view:\n\n```python\n\n```python\nfrom django.http import HttpResponse, JsonResponse\nfrom djestful.views import APIView\nfrom djestful.decorators import action\nfrom django.http import HttpRequest\n\nclass TestView(APIView):\n\n    @action.post('/users/me', summary='This is a test post endpoint')\n    async def post_test_endpoint(self, request: HttpRequest, *args: Any, **kwargs: Any) -\u003e HttpResponse:\n        return JsonResponse(\n            {\n                'message': 'This is a test POST endpoint',\n                'function': 'post_test_endpoint',\n            }\n        )\n\n    @action.get('/users/me', summary='This is a test get endpoint')\n    async def get_test_endpoint(self, request: HttpRequest, *args, **kwargs) -\u003e HttpResponse:\n        return JsonResponse(\n            {\n                'message': 'This is a test endpoint',\n                'function': 'get_test_endpoint',\n            }\n        )\n\n## urls.py\n\nfrom django.urls import path\nfrom djestful.routers import Router\nfrom test_app.views import TestView, TestView2\n\n\nrouter = Router()\nrouter.include('api', TestView, basename='test_view')\n\n\nurlpatterns = [\n   path('api/', include(router.urls)),\n]\n\n\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-byte%2Fdjestful-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-byte%2Fdjestful-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-byte%2Fdjestful-framework/lists"}