Files
fastapi_best_architecture/backend/plugin/config/api/v1/sys/config.py
Wu Clan 319ba13df1 Optimize routes to better align with RESTful (#673)
* Optimize routes to better align with RESTful

* Add codes endpoint description

* Update jinja templates

* fix typo

* fix sql
2025-06-19 11:06:34 +08:00

88 lines
2.7 KiB
Python

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from typing import Annotated
from fastapi import APIRouter, Body, Depends, Path, Query
from backend.common.pagination import DependsPagination, PageData, paging_data
from backend.common.response.response_schema import ResponseModel, ResponseSchemaModel, response_base
from backend.common.security.jwt import DependsJwtAuth
from backend.common.security.permission import RequestPermission
from backend.common.security.rbac import DependsRBAC
from backend.database.db import CurrentSession
from backend.plugin.config.schema.config import (
CreateConfigParam,
GetConfigDetail,
UpdateConfigParam,
)
from backend.plugin.config.service.config_service import config_service
router = APIRouter()
@router.get('/{pk}', summary='获取参数配置详情', dependencies=[DependsJwtAuth])
async def get_config(pk: Annotated[int, Path(description='参数配置 ID')]) -> ResponseSchemaModel[GetConfigDetail]:
config = await config_service.get(pk=pk)
return response_base.success(data=config)
@router.get(
'',
summary='分页获取所有参数配置',
dependencies=[
DependsJwtAuth,
DependsPagination,
],
)
async def get_configs_paged(
db: CurrentSession,
name: Annotated[str | None, Query(description='参数配置名称')] = None,
type: Annotated[str | None, Query(description='参数配置类型')] = None,
) -> ResponseSchemaModel[PageData[GetConfigDetail]]:
config_select = await config_service.get_select(name=name, type=type)
page_data = await paging_data(db, config_select)
return response_base.success(data=page_data)
@router.post(
'',
summary='创建参数配置',
dependencies=[
Depends(RequestPermission('sys:config:add')),
DependsRBAC,
],
)
async def create_config(obj: CreateConfigParam) -> ResponseModel:
await config_service.create(obj=obj)
return response_base.success()
@router.put(
'/{pk}',
summary='更新参数配置',
dependencies=[
Depends(RequestPermission('sys:config:edit')),
DependsRBAC,
],
)
async def update_config(pk: Annotated[int, Path(description='参数配置 ID')], obj: UpdateConfigParam) -> ResponseModel:
count = await config_service.update(pk=pk, obj=obj)
if count > 0:
return response_base.success()
return response_base.fail()
@router.delete(
'',
summary='批量删除参数配置',
dependencies=[
Depends(RequestPermission('sys:config:del')),
DependsRBAC,
],
)
async def delete_configs(pks: Annotated[list[int], Body(description='参数配置 ID 列表')]) -> ResponseModel:
count = await config_service.delete(pks=pks)
if count > 0:
return response_base.success()
return response_base.fail()