从0到1开发自动化运维平台接口文档分页视图和权限配置

　　安装依赖pipinstalldjangorestframeworksimplejwtpipinstalldjangofilterpipinstallcoreapipipinstalldrfyasg配置swagger接口文档
　　1、添加drfyasg到settings。pyINSTALLEDAPPS〔。。。restframework，drfyasg，cmdb。apps。CmdbConfig，〕
　　2、配置路由fromrestframeworkimportpermissionsfromdrfyasg。viewsimportgetschemaviewfromdrfyasgimportopenapischemaviewgetschemaview（openapi。Info（titleDevOps运维平台，defaultversionv1，descriptionDevOps运维平台接口文档，termsofservice，contactopenapi。Contact（emailqqinglaihotmail。com），licenseopenapi。License（nameBSDLicense），），publicTrue，permissionclasses（permissions。AllowAny，），）。。。urlpatterns〔path（apidoc，schemaview。withui（swagger，。。。〕restframework配置drf配置RESTFRAMEWORK｛自定义分页DEFAULTPAGINATIONCLASS：common。extends。pagination。CustomPagination，PAGESIZE：20，用户登陆认证方式DEFAULTAUTHENTICATIONCLASSES：（restframeworksimplejwt。authentication。JWTAuthentication，restframework。authentication。SessionAuthentication，restframework。authentication。BasicAuthentication，），全局权限拦截DEFAULTPERMISSIONCLASSES：（common。extends。permissions。RbacPermission，），DEFAULTSCHEMACLASS：restframework。schemas。coreapi。AutoSchema，DEFAULTFILTERBACKENDS：（djangofilters。restframework。DjangoFilterBackend，restframework。filters。SearchFilter，restframework。filters。OrderingFilter，），DEFAULTRENDERERCLASSES：〔restframework。renderers。JSONRenderer，restframework。renderers。BrowsableAPIRenderer〕ifDEBUGelse〔restframework。rend分页扩展！usrbinenvpythonencoding：utf8author：CharlesLaifile：pagination。pytime：2023032615：22contact：qqinglaihotmail。comhereputtheimportlibfromrestframework。paginationimportPageNumberPagination，LimitOffsetPaginationfromrestframework。responseimportResponsefromrestframeworkimportstatusclassCustomPagination（PageNumberPagination）：defgetpaginatedresponse（self，data）：returnResponse（｛data：｛list：data，total：self。page。paginator。count，next：self。getnextlink（），previous：self。getpreviouslink（）｝，success：True，errorCode：0，errorMessage：None｝，statusstatus。HTTP200OK）自定义公共视图！usrbinenvpythonencoding：utf8author：CharlesLaifile：viewsets。pytime：2023032614：42contact：qqinglaihotmail。comhereputtheimportlibimportinspectfromrestframework。permissionsimportIsAuthenticatedfromrestframework。responseimportResponsefromrestframeworkimportstatusfromrestframeworkimportviewsetsfromrestframeworkimportpaginationfromrestframework。settingsimportapisettingsfromrestframework。filtersimportOrderingFilterfromdjango。db。models。queryimportQuerySetfromdjango。db。modelsimportProtectedErrorfromdjango。core。cacheimportcacheimportpytzimportloggingloggerlogging。getLogger（name）defopsresponse（data，successTrue，errorCode0，errorMessageNone，statusstatus。HTTP200OK）：返回自定义data列表数据格式：｛list：〔〕，current？：number，pageSize？：number，total？：number，｝returnResponse（｛data：data，success：success，errorCode：errorCode，errorMessage：errorMessage｝，statusstatus）classAutoModelViewSet（viewsets。ModelViewSet）：Aviewsetthatprovidesdefaultcreate（），retrieve（），update（），partialupdate（），destroy（）andlist（）actions。permissionclasses〔IsAuthenticated〕permissionclassesbyaction｛｝filterbackends（OrderingFilter，）definit（self，args，kwargs）：ifnothasattr（self，queryset）：raiseAttributeError（必须定义类属性queryset）ifnothasattr（self，serializerclass）：raiseAttributeError（必须定义类属性serializerclass）super（）。init（args，kwargs）defgetserializer（self，args，kwargs）：重写getserializer类，用来支持自动获取不同的serializerclass例子：list方法，设置一个serializerlistclass，则调用getserializer的时候，优先获取命名格式serializer｛callfuncname｝class：paramargs：：paramkwargs：：return：callfuncnameinspect。stack（）〔1〕〔3〕serializerclassgetattr（self，fserializer｛callfuncname｝class，None）ifnotserializerclass：serializerclassself。getserializerclass（）kwargs〔context〕self。getserializercontext（）returnserializerclass（args，kwargs）defgetobject（self）：returnsuper（AutoModelViewSet，self）。getobject（）defgetpermissions（self）：try：return〔permission（）forpermissioninself。permissionclassesbyaction〔self。action〕〕exceptKeyError：return〔permission（）forpermissioninself。permissionclasses〕defgetpermissionfromrole（self，request）：try：permsrequest。user。roles。values（permissionsmethod，）。distinct（）return〔p〔permissionsmethod〕forpinperms〕except（AttributeError，TypeError）：return〔〕defextendfilter（self，queryset）：returnquerysetdefgetqueryset（self）：assertself。querysetisnotNone，（sshouldeitherincludeaquerysetattribute，oroverridethegetqueryset（）method。self。class。name）querysetself。extendfilter（self。queryset）ifisinstance（queryset，QuerySet）：querysetqueryset。all（）returnqueryset。distinct（）defcreate（self，request，args，kwargs）：try：request。data〔name〕request。data〔name〕。strip（）。replace（，）exceptBaseExceptionase：logger。debug（exception，str（e））serializerself。getserializer（datarequest。data）ifnotserializer。isvalid（）：returnopsresponse（｛｝，successFalse，errorCode40000，errorMessageserializer。errors）try：self。performcreate（serializer）exceptBaseExceptionase：returnopsresponse（｛｝，successFalse，errorCode50000，errorMessagestr（e），statusstatus。HTTP500INTERNALSERVERERROR）returnopsresponse（serializer。data）deflist（self，request，pkNone，args，kwargs）：querysetself。filterqueryset（self。getqueryset（））pagesizerequest。queryparams。get（pagesize，None）ifnotpagesize：pagesizeapisettings。PAGESIZEpagination。PageNumberPagination。pagesizepagesizepageself。paginatequeryset（queryset）ifpageisnotNone：serializerself。getserializer（page，manyTrue）returnself。getpaginatedresponse（serializer。data）serializerself。getserializer（queryset，manyTrue）returnopsresponse（｛list：serializer。data，total：queryset。count（）｝）defupdate（self，request，args，kwargs）：instanceself。getobject（）partialkwargs。pop（partial，False）try：request。data〔name〕request。data〔name〕。strip（）。replace（，）exceptBaseExceptionase：logger。warning（f不包含name字段：｛str（e）｝）serializerself。getserializer（instance，datarequest。data，partialpartial）ifnotserializer。isvalid（）：returnopsresponse（｛｝，successFalse，errorCode40000，errorMessageserializer。errors）try：self。performupdate（serializer）exceptBaseExceptionase：returnopsresponse（｛｝，successFalse，errorCode50000，errorMessagestr（e））ifgetattr（instance，prefetchedobjectscache，None）：instance。prefetchedobjectscache｛｝data｛data：serializer。data，status：success，code：20000｝returnopsresponse（serializer。data）defretrieve（self，request，args，kwargs）：instanceself。getobject（）serializerself。getserializer（instance）returnopsresponse（serializer。data）defdestroy（self，request，args，kwargs）：instanceself。getobject（）try：self。performdestroy（instance）exceptProtectedError：存在关联数据，不可删除returnopsresponse（｛｝，successFalse，errorCode40300，errorMessage存在关联数据，禁止删除！）exceptBaseExceptionase：logger。exception（f删除数据发生错误｛e｝，｛e。class｝）returnopsresponse（｛｝，successFalse，errorCode50000，errorMessagef删除异常：｛str（e）｝）returnopsresponse（删除成功）classAutoModelParentViewSet（AutoModelViewSet）：defgetqueryset（self）：assertself。querysetisnotNone，（sshouldeitherincludeaquerysetattribute，oroverridethegetqueryset（）method。self。class。name）querysetself。extendfilter（self。queryset）ifself。actionlist：ifnotself。request。queryparams。get（search）：querysetqueryset。filter（parentisnullTrue）ifisinstance（queryset，QuerySet）：querysetqueryset。all（）returnqueryset。distinct（）自定义权限校验！usrbinenvpythonencoding：utf8author：CharlesLaifile：permissions。pytime：2023032615：27contact：qqinglaihotmail。comhereputtheimportlibfromrestframework。permissionsimportBasePermissionfromconfigimportplatformimportloggingloggerlogging。getLogger（name）classRbacPermission（BasePermission）：自定义权限classmethoddefcheckisadmin（cls，request）：returnrequest。user。isauthenticatedandrequest。user。roles。filter（name管理员）。count（）0classmethoddefgetpermissionfromrole（cls，request）：try：permsrequest。user。roles。values（permissionsmethod，）。distinct（）return〔p〔permissionsmethod〕forpinperms〕exceptAttributeError：return〔〕defhaspermission（self，request，view）：权限获取方式从permsmap中获取，通过request。method，http请求方法来获取对应权限点1。默认格式permsmap（｛：（admin，管理员）｝，｛：（k8sall，k8s管理）｝，｛get：（k8slist，查看k8s）｝，｛post：（k8screate，创建k8s）｝，｛put：（k8sedit，编辑k8s）｝，｛delete：（k8sdelete，删除k8s）｝）2。自定义方法格式permsmap（｛gettestdata：（gettestdata，获取测试数据）｝，）此时格式为｛http请求方法｝｛ViewSet自定义action｝：paramrequest：restframeworkrequest对象：paramview：restframeworkview对象：return：methodrequest。request。method。lower（）urlwhitelistplatform〔whitelist〕ifplatformelse〔〕pathinforequest。pathinfoforiteminurlwhitelist：urlitem〔url〕ifurlinpathinfo：logger。debug（f请求地址｛pathinfo｝命中白名单｛url｝，放行）returnTrueissuperuserrequest。user。issuperuser超级管理员或者白名单模式直接放行ifissuperuser：logger。debug（f用户｛request。user｝是超级管理员，放行issuperuser｛issuperuser｝）returnTrueisadminRbacPermission。checkisadmin（request）permsself。getpermissionfromrole（request）不是管理员且权限列表为空的情况下，直接拒绝ifnotisadminandnotperms：logger。debug（f用户｛request。user｝不是管理员且权限列表为空，直接拒绝）returnFalsepermsmapview。permsmap未配置权限映射的视图一律禁止访问ifnothasattr（view，permsmap）：logger。debug（f未配置权限映射的视图一律禁止访问｛view｝）returnFalsecustommethodNonedefaultfuncs〔create，list，retrieve，update，destroy〕actionview。actioncustommethodf｛method｝｛action｝foriinpermsmap：logger。debug（fpermsmapitem｛i｝）formethod，aliasini。items（）：如果是管理员，判断当前permsmap是否带有｛：（admin，管理员）｝标记，如果有，则当前ViewSet所有方法全放行ifisadminand（methodandalias〔0〕admin）：logger。debug（管理员判断通过，放行）returnTrue如果带有某个模块的管理权限，则当前模块所有方法都放行ifmethodandalias〔0〕inperms：logger。debug（模块管理权限判断通过，放行）returnTrue判断自定义action的情况｛gettestdata：（gettestdata，获取测试数据）｝，｛testdata：（gettestdata，获取测试数据）｝，ifcustommethodandalias〔0〕inpermsand（custommethodmethodormethodf｛action｝）：logger。debug（自定义action权限判断通过，放行）returnTrue判断是否拥有ViewSet某个方法的权限，有则放行｛get：（workflowlist，查看工单）｝，ifmethodmethodandalias〔0〕inperms：logger。debug（f｛method｝方法权限判断通过，放行）returnTruelogger。debug（f｛pathinfo｝没有符合条件的，则默认禁止访问）returnFalsedefhaspermission（self，request，view）：resself。haspermission（request，view）记录权限异常的操作ifnotres：passreturnresclassAdminPermission（BasePermission）：defhaspermission（self，request，view）：ifRbacPermission。checkisadmin（request）：returnTruereturnFalseclassObjPermission（BasePermission）：密码管理对象级权限控制defhasobjectpermission（self，request，view，obj）：permsRbacPermission。getpermissionfromrole（request）ifadmininperms：returnTrueelifrequest。user。idobj。uidid：returnTrue更新cmdb模块视图
　　我们之前已经完成的viewcmdb。py文件里，有几处需要更新：
　　1、将viewsets。ModelViewSet更改成公共视图里的AutoModelViewSet
　　2、将Response更改成opsreponse，确保返回内容格式一致。运行项目（venv）ydevopsbackendcdhomecharlesydevopsbackend；usrbinenvhomecharlesydevopsbackendvenvbinpythonhomecharles。vscodeserverextensionsmspython。python2023。5。10791008pythonFileslibpythondebugpyadapter。。。。debugpylauncher41223homecharlesydevopsbackendmanage。pyrunserver0。0。0。0：9000WatchingforfilechangeswithStatReloaderPerformingsystemchecks。。。Systemcheckidentifiednoissues（0silenced）。March26，202318：50：30Djangoversion4。1。7，usingsettingsdevopsbackend。settingsStartingdevelopmentserverathttp：0。0。0。0：9000QuittheserverwithCONTROLC。
　　访问接口文档http：localhost：9000apidoc
　　在这个页面，我们可以做一些CRUD操作，如查看环境（由于数据量小，可以先把settings。py里的默认PAGESIZE改为1）
　　Okay，今天先到这吧。。。