關(guān)于swagger
Swagger能成為最受歡迎的REST APIs文檔生成工具之一怀伦，有以下幾個(gè)原因：
- Swagger 可以生成一個(gè)具有互動(dòng)性的API控制臺(tái)，開發(fā)者可以用來快速學(xué)習(xí)和嘗試API复唤。
- Swagger 可以生成客戶端SDK代碼用于各種不同的平臺(tái)上的實(shí)現(xiàn)盈匾。
- Swagger 文件可以在許多不同的平臺(tái)上從代碼注釋中自動(dòng)生成。
- Swagger 有一個(gè)強(qiáng)大的社區(qū)，里面有許多強(qiáng)悍的貢獻(xiàn)者吴趴。
下面就實(shí)戰(zhàn)django rest swagger為drf生成api接口文檔
環(huán)境
- Python3.6
- Django1.11
- django-rest-swagger
- djangorestframework
安裝
pip install django==1.11.6
pip instal djangorestframework
pip install django-rest-swagger
創(chuàng)建項(xiàng)目和app
startproject apitest
startapp api
配置 rest_api/settings.py
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
# 加入以下
'api',
'rest_framework',
'rest_framework_swagger',
]
# swagger 配置項(xiàng)
SWAGGER_SETTINGS = {
# 基礎(chǔ)樣式
'SECURITY_DEFINITIONS': {
"basic":{
'type': 'basic'
}
},
# 如果需要登錄才能夠查看接口文檔, 登錄的鏈接使用restframework自帶的.
'LOGIN_URL': 'rest_framework:login',
'LOGOUT_URL': 'rest_framework:logout',
# 'DOC_EXPANSION': None,
# 'SHOW_REQUEST_HEADERS':True,
# 'USE_SESSION_AUTH': True,
# 'DOC_EXPANSION': 'list',
# 接口文檔中方法列表以首字母升序排列
'APIS_SORTER': 'alpha',
# 如果支持json提交, 則接口文檔中包含json輸入框
'JSON_EDITOR': True,
# 方法列表字母排序
'OPERATIONS_SORTER': 'alpha',
'VALIDATOR_URL': None,
}
配置api/serializer.py
# 序列化
from django.contrib.auth.models import User,Group
from rest_framework import serializers
class UserSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model = User
fields = "__all__"
class GroupSerializer(serializers.HyperlinkedModelSerializer):
class Meta:
model =Group
fields = "__all__"
配置api/views.py
# 視圖
from django.contrib.auth.models import User,Group
from rest_framework import viewsets
from api.serializers import UserSerializer,GroupSerializer
# Create your views here.
class UserViewSet(viewsets.ModelViewSet):
'''查看，編輯用戶的界面'''
queryset = User.objects.all().order_by('-date_joined')
serializer_class = UserSerializer
class GroupViewSet(viewsets.ModelViewSet):
'''查看侮攀，編輯組的界面'''
queryset = Group
serializer_class = GroupSerializer
配置apitest/urls.py
from django.conf.urls import url,include
from django.contrib import admin
from rest_framework import routers
from api import views
# 路由
router = routers.DefaultRouter()
router.register(r'users',views.UserViewSet,base_name='user')
router.register(r'groups',views.GroupViewSet,base_name='group')
# 重要的是如下三行
from rest_framework.schemas import get_schema_view
from rest_framework_swagger.renderers import SwaggerUIRenderer, OpenAPIRenderer
schema_view = get_schema_view(title='Users API', renderer_classes=[OpenAPIRenderer, SwaggerUIRenderer])
urlpatterns = [
# swagger接口文檔路由
url(r'^docs/', schema_view, name="docs"),
url(r'^admin/', admin.site.urls),
url(r'^',include(router.urls)),
# drf登錄
url(r'^api-auth/',include('rest_framework.urls',namespace='rest_framework'))
]
最終效果
drf自帶的接口UI
drf.png
swagger UI
swagger ui.png
