restful风格复数形式统一管理

Author: wu-clan

backend/app/api/jwt_security.py

@@ -18,7 +18,7 @@
 
 pwd_context = CryptContext(schemes=['bcrypt'], deprecated='auto')  # 密码加密
 
-oauth2_schema = OAuth2PasswordBearer(tokenUrl='/v1/user/login')  # 指明客户端请求token的地址
+oauth2_schema = OAuth2PasswordBearer(tokenUrl='/v1/users/login')  # 指明客户端请求token的地址
 
 headers = {"WWW-Authenticate": "Bearer"}  # 异常返回规范
 

backend/app/api/v1/__init__.py

@@ -7,5 +7,5 @@
 
 v1 = APIRouter(prefix='/v1')
 
-v1.include_router(user, tags=['用户'])
+v1.include_router(user, prefix='/users', tags=['用户'])
 v1.include_router(rd, prefix='/redis', tags=['测试-Redis'])

backend/app/api/v1/v1_test_redis.py

@@ -8,21 +8,21 @@
 rd = APIRouter()
 
 
-@rd.post('/redis')
+@rd.post('')
 async def test_redis():
     result = await redis_client.set('test', 'test')
     if result:
         return Response200(data=result)
 
 
-@rd.get('/redis')
+@rd.get('')
 async def get_redis():
     result = await redis_client.get('test')
     if result:
         return Response200(data=result)
 
 
-@rd.delete('/redis')
+@rd.delete('')
 async def test_redis():
     result = await redis_client.delete('test')
     if result:

backend/app/api/v1/v1_user.py

@@ -35,7 +35,7 @@
 headers = {"WWW-Authenticate": "Bearer"}
 
 
-@user.post('/user/login', summary='用户登录调试', response_model=Token,
+@user.post('/login', summary='用户登录调试', response_model=Token,
            description='form_data登录，为直接配合swagger-ui认证使用，接口数据与json_data登录一致，自由选择，注释其一即可', )
 async def user_login(form_data: OAuth2PasswordRequestForm = Depends(), db: AsyncSession = Depends(get_db)) -> Any:
     current_user = await crud_user.get_user_by_username(db, form_data.username)
@@ -75,7 +75,7 @@ async def user_login(form_data: OAuth2PasswordRequestForm = Depends(), db: Async
         )
 
 
-# @user.post('/user/login', summary='用户登录', description='json_data登录，不能配合swagger-ui认证使用', response_model=Token)
+# @user.post('/login', summary='用户登录', description='json_data登录，不能配合swagger-ui认证使用', response_model=Token)
 # async def user_login(obj: Auth, db: AsyncSession = Depends(get_db)) -> Any:
 #     current_user = await crud_user.get_user_by_username(db, obj.username)
 #     if not current_user:
@@ -114,7 +114,7 @@ async def user_login(form_data: OAuth2PasswordRequestForm = Depends(), db: Async
 #         )
 
 
-@user.post('/user/login/email/captcha', summary='获取邮箱登录验证码')
+@user.post('/login/email/captcha', summary='获取邮箱登录验证码')
 async def user_login_email_captcha(request: Request, obj: ELCode, tasks: BackgroundTasks,
                                    db: AsyncSession = Depends(get_db)) -> Any:
     if not await crud_user.check_email(db, obj.email):
@@ -136,7 +136,7 @@ async def user_login_email_captcha(request: Request, obj: ELCode, tasks: Backgro
     return Response200(msg='验证码发送成功')
 
 
-@user.post('/user/login/email', summary='邮箱登录', description='邮箱登录, 需同时必须开启login账号密码登录接口', response_model=Token)
+@user.post('/login/email', summary='邮箱登录', description='邮箱登录, 需同时必须开启login账号密码登录接口', response_model=Token)
 async def user_login_email(request: Request, obj: Auth2, db: AsyncSession = Depends(get_db)) -> Any:
     if not settings.REDIS_OPEN:
         raise HTTPException(status_code=500, detail='登陆失败, 服务器未启用此服务')
@@ -176,12 +176,12 @@ async def user_login_email(request: Request, obj: Auth2, db: AsyncSession = Depe
     )
 
 
-@user.post('/user/logout', summary='用户退出', dependencies=[Depends(get_current_user)])
+@user.post('/logout', summary='用户退出', dependencies=[Depends(get_current_user)])
 async def user_logout() -> Any:
     return Response200(msg='退出登录成功')
 
 
-@user.post('/user/register', summary='用户注册')
+@user.post('/register', summary='用户注册')
 async def user_register(obj: CreateUser, db: AsyncSession = Depends(get_db)) -> Any:
     username = await crud_user.get_user_by_username(db, obj.username)
     if username:
@@ -200,7 +200,7 @@ async def user_register(obj: CreateUser, db: AsyncSession = Depends(get_db)) ->
     })
 
 
-@user.post('/user/password/reset/captcha', summary='获取密码重置验证码', description='可以通过用户名或者邮箱重置密码')
+@user.post('/password/reset/captcha', summary='获取密码重置验证码', description='可以通过用户名或者邮箱重置密码')
 async def password_reset_captcha(username_or_email: str, response: Response, tasks: BackgroundTasks,
                                  db: AsyncSession = Depends(get_db)) -> Any:
     code = text_captcha()
@@ -247,7 +247,7 @@ async def password_reset_captcha(username_or_email: str, response: Response, tas
         return Response200(msg='验证码发送成功')
 
 
-@user.post('/user/password/reset', summary='密码重置请求')
+@user.post('/password/reset', summary='密码重置请求')
 async def password_reset(obj: ResetPassword, request: Request, response: Response,
                          db: AsyncSession = Depends(get_db)) -> Any:
     pwd1 = obj.password1
@@ -265,17 +265,17 @@ async def password_reset(obj: ResetPassword, request: Request, response: Respons
     return Response200(msg='密码重置成功')
 
 
-@user.get('/user/password/reset/done', summary='重置密码完成')
+@user.get('/password/reset/done', summary='重置密码完成')
 async def password_reset_done() -> Any:
     return Response200(msg='重置密码完成')
 
 
-@user.get('/user', summary='查看用户信息')
+@user.get('/me', summary='查看用户信息')
 async def get_userinfo(current_user=Depends(get_current_user)) -> Any:
     return Response200(msg='查看用户信息成功', data=current_user)
 
 
-@user.put('/user', summary='更新用户信息')
+@user.put('/me', summary='更新用户信息')
 async def update_userinfo(
         username: str = Form(..., title='用户名'),
         email: str = Form(..., title='邮箱'),
@@ -335,7 +335,7 @@ async def update_userinfo(
     })
 
 
-@user.delete('/user/avatar', summary='删除头像文件')
+@user.delete('/me/avatar', summary='删除头像文件')
 async def delete_avatar(current_user=Depends(jwt_security.get_current_user), db: AsyncSession = Depends(get_db)) -> Any:
     current_filename = await crud_user.get_avatar_by_username(db, current_user.username)
     if current_filename is not None:
@@ -349,13 +349,13 @@ async def delete_avatar(current_user=Depends(jwt_security.get_current_user), db:
     return Response200(msg='删除用户头像成功')
 
 
-@user.get('/users', summary='获取用户列表', response_model=Page[GetUserInfo],
+@user.get('', summary='获取用户列表', response_model=Page[GetUserInfo],
           dependencies=[Depends(jwt_security.get_current_is_superuser)])
 async def get_all_users(db: AsyncSession = Depends(get_db)) -> Any:
     return await paginate(db, crud_user.get_users())
 
 
-@user.post('/user/{id}/super', summary='修改用户超级权限', dependencies=[Depends(jwt_security.get_current_is_superuser)])
+@user.post('/{id}/super', summary='修改用户超级权限', dependencies=[Depends(jwt_security.get_current_is_superuser)])
 async def super_set(id: int, db: AsyncSession = Depends(get_db)) -> Any:
     if await crud_user.get_user_by_id(db, id):
         if await crud_user.super_set(db, id):
@@ -364,7 +364,7 @@ async def super_set(id: int, db: AsyncSession = Depends(get_db)) -> Any:
     return Response404(msg=f'用户 {id} 不存在')
 
 
-@user.post('/user/{id}/action', summary='修改用户状态', dependencies=[Depends(jwt_security.get_current_is_superuser)])
+@user.post('/{id}/action', summary='修改用户状态', dependencies=[Depends(jwt_security.get_current_is_superuser)])
 async def active_set(id: int, db: AsyncSession = Depends(get_db)) -> Any:
     if await crud_user.get_user_by_id(db, id):
         if await crud_user.active_set(db, id):
@@ -373,7 +373,7 @@ async def active_set(id: int, db: AsyncSession = Depends(get_db)) -> Any:
     return Response404(msg=f'用户 {id} 不存在')
 
 
-@user.delete('/user', summary='用户注销', description='用户注销 != 用户退出，注销之后用户将从数据库删除')
+@user.delete('/me', summary='用户注销', description='用户注销 != 用户退出，注销之后用户将从数据库删除')
 async def delete_user(current_user=Depends(get_current_user), db: AsyncSession = Depends(get_db)) -> Any:
     current_filename = await crud_user.get_avatar_by_username(db, current_user.username)
     try: