Django rest framework 應用解答

Django rest framework 應用解答

Django項目建立

#django-admin startproject assets //建立項目 #cd assets #python manage.py startapp restfm //建立應用app

pip安裝對應的framework包

• 支持更好的前端交互，所以採用swagger

#pip install django-rest-swagger==2.1.2  #pip install djangorestframework==3.7.3 

setting中配置加入framework應用

INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'assets_control', 'rest_framework', ]

 

• framework配置信息：json、模板、分頁功能

#REST FRAMEWORK config info,with default page limit.
REST_FRAMEWORK = { 'TEST_REQUEST_RENDERER_CLASSES': ( 'rest_framework.renderers.MultiPartRenderer', 'rest_framework.renderers.JSONRenderer', 'rest_framework.renderers.TemplateHTMLRenderer' ), 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination', 'PAGE_SIZE': 100 }

 

採用默認swagger格式前端展現

sweet-framework POST /sweet-framework/cloud/error-report 發送用戶錯誤報告 GET /sweet-framework/cloud/hystrix/metrics 查詢全部Hystrix統計指標 GET /sweet-framework/cloud/security-rules 服務調用安全規則 GET /sweet-framework/cloud/service-list 服務調用安全規則 GET /sweet-framework/configuration/json 查詢應用的配置參數 GET /sweet-framework/configuration/namespaces 查詢應用配置項命名空間 GET /sweet-framework/errors/json 顯示應用的錯誤碼 POST /sweet-framework/i18n/locale 改變後端響應消息的默認語言 POST /sweet-framework/logger/config 配置日誌級別 GET /sweet-framework/logger/query 查詢日誌配置 GET /sweet-framework/metrics 獲取應用統計指標 GET /sweet-framework/touch 應用活動檢測

根據須要使用自定義的swagger.json文件

• 配置

在setting中設置指定swagger.json文件目錄便可 

• 結果顯示

assets : 資產管理服務 Show/Hide List Operations Expand Operations GET /assets/room/list/ 查詢資產中的機房列表信息 POST /assets/room/create/ 建立機房信息 GET /assets/room/detail/{id}/ 獲取某個機房id 的詳細信息 DELETE /assets/room/detail/{id}/update/ 刪除一個機房記錄 PUT /assets/room/detail/{id}/update/ 修改一個機房信息

 

• swagger在線編輯器 swagger在線編輯器