在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称:encode/django-rest-framework开源软件地址:https://github.com/encode/django-rest-framework开源编程语言:Python 91.0%开源软件介绍:Django REST frameworkAwesome web-browsable Web APIs. Full documentation for the project is available at https://www.django-rest-framework.org/. FundingREST framework is a collaboratively funded project. If you use REST framework commercially we strongly encourage you to invest in its continued development by signing up for a paid plan. The initial aim is to provide a single full-time position on REST framework. Every single sign-up makes a significant impact towards making that possible. Many thanks to all our wonderful sponsors, and in particular to our premium backers, Sentry, Stream, Spacinov, Retool, bit.io, PostHog, CryptAPI, and FEZTO. OverviewDjango REST framework is a powerful and flexible toolkit for building Web APIs. Some reasons you might want to use REST framework:
There is a live example API for testing purposes, available here. Below: Screenshot from the browsable API Requirements
We highly recommend and only officially support the latest patch release of each Python and Django series. InstallationInstall using
Add INSTALLED_APPS = [
...
'rest_framework',
] ExampleLet's take a look at a quick example of using REST framework to build a simple model-backed API for accessing users and groups. Startup up a new project like so...
Now edit the from django.urls import path, include
from django.contrib.auth.models import User
from rest_framework import serializers, viewsets, routers
# Serializers define the API representation.
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = ['url', 'username', 'email', 'is_staff']
# ViewSets define the view behavior.
class UserViewSet(viewsets.ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
# Routers provide a way of automatically determining the URL conf.
router = routers.DefaultRouter()
router.register(r'users', UserViewSet)
# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
path('', include(router.urls)),
path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
] We'd also like to configure a couple of settings for our API. Add the following to your INSTALLED_APPS = [
... # Make sure to include the default installed apps here.
'rest_framework',
]
REST_FRAMEWORK = {
# Use Django's standard `django.contrib.auth` permissions,
# or allow read-only access for unauthenticated users.
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly',
]
} That's it, we're done!
You can now open the API in your browser at You can also interact with the API using command line tools such as
Or to create a new user:
Documentation & SupportFull documentation for the project is available at https://www.django-rest-framework.org/. For questions and support, use the REST framework discussion group, or You may also want to follow the author on Twitter. SecurityPlease see the security policy. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论