草庐IT

FastAPI项目开发最佳实践

小餐包 2023-10-14 原文

最近FastAPI项目特别火，以下是我们项目组在用FastAPI开发时的总结的一些最佳实践以及一些代码规范，分享给大家。

通用规范

  1. 请勿将敏感信息包括但不限于密码信息，客户信息等上传到代码库！
  2. 代码提交前检查一下有没有调试时的print或者log代码没删除干净；
  3. 代码风格：用Pycharm的同学，先Ctrl+Alt+L应用一下PEP8风格，再用Ctrl+Alt+I调整一下Import顺序。 用VS Code的请用插件搞定上述需求；
  4. Commit 信息：请贴上需求管理系统相关链接；
  5. PR：push自己的开发分支到远程，如果commit较多（超过3个）建议本地rebase成一个commit以后再push上来，提交评审后根据评审意见逐条确认，全部修改以后再push一个新的commit。
  6. 分支合并策略：默认情况下合并分支采用squash方式，且合并后会删除该分支，如需要保存请提前沟通或者备注。
  7. 提交评审请对照下面的规范?自检；

FastAPI开发规范

  1. router函数需要添加docs，方便用户了解接口用途, 例如：

    @router.get("/{callback_id}/records/last", response_model=CallBackRecordResponse)
async def get_last_callback_record(callback_id: int, db: Session = Depends(get_db)):
    """查询最后一次回调记录"""
    return crud.get_last_callback_record(db, callback_id)

  2. body和response应该声明为pydentic.BaseModel的子类，并且使用Field类声明默认值（如果有），描述信息（必须），举例值（如果必要）等，例如：

    class CallBackBase(BaseModel):
    path: Optional[str] = Field(
        default=None,
        example="",
        description="If not specific, it will generate random path")
    tags: Optional[list] = Field(
        default=None,
        description="tags of the custom callback",
        example=["tag1", "tag2"])

  3. 如果router函数不能直接推断出返回值类型的话（比如CRUD的结果），应当在router装饰器的resposne_model参数里声明类型，例如：

    @router.get("/{callback_id}", response_model=CallBackResponse)
async def get_callback(callback_id: int, db: Session = Depends(get_db)):
    """查询回调URL的定义"""
    schema_callback = crud.get_callback_by_id(db, callback_id)
    if not schema_callback:
        raise HTTPException(status_code=404, detail="Callback does not exists!")
    return schema_callback

  4. schemas里的类名应该使用XXXBase, XXXCreate, XXXResponse等形式，避免跟sqlalchemy的models类名冲突，例如：

    # models.callback.py
class CallBack(Base): 
 ...
 

# schemas.callback.py
class CallBackBase(BaseModel): # 基类
 ...
 
class CallBackCreate(CallBackBase): # 创建类
 pass
 
class CallBackResponse(CallBackBase): #响应类
 ...

  5. 原则上所有资源都要添加tags域，方便后续进行资源筛选以及权限控制；

RESTAPI规范

  • 参考阮一峰的文档http://www.ruanyifeng.com/blog/2018/10/restful-api-best-practices.html， 提一下需要注意的点

    • 路径使用复数；

    • 注意使用规范的状态码，参考下表：比如POST请求一般成功会返回201，资源不存在返回404等；

    • 方法 CRUD 集合操作 个体操作
      POST Create 201 (Created), 'Location' header with link to /customers/{id} containing new ID. 404 (Not Found), 409 (Conflict) if resource already exists..
      GET Read 200 (OK), list of customers. Use pagination, sorting and filtering to navigate big lists. 200 (OK), single customer. 404 (Not Found), if ID not found or invalid.
      PUT Update/Replace 405 (Method Not Allowed), unless you want to update/replace every resource in the entire collection. 200 (OK) or 204 (No Content). 404 (Not Found), if ID not found or invalid.
      PATCH Update/Modify 405 (Method Not Allowed), unless you want to modify the collection itself. 200 (OK) or 204 (No Content). 404 (Not Found), if ID not found or invalid.
      DELETE Delete 405 (Method Not Allowed), unless you want to delete the whole collection—not often desirable. 200 (OK). 404 (Not Found), if ID not found or invalid.
项目开发FastAPIcallbackcodetd

有关FastAPI项目开发最佳实践的更多相关文章

  1. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇，就使用ruby​​onrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？ 最佳答案 不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提

  2. ruby - 如何在 buildr 项目中使用 Ruby 代码？ - 2

    如何在buildr项目中使用Ruby？我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序，我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/)，但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻，因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  3. ruby - 解析 RDFa、微数据等的最佳方式是什么，使用统一的模式/词汇(例如 schema.org)存储和显示信息 - 2

    我主要使用Ruby来执行此操作，但到目前为止我的攻击计划如下:使用gemsrdf、rdf-rdfa和rdf-microdata或mida来解析给定任何URI的数据。我认为最好映射到像schema.org这样的统一模式，例如使用这个yaml文件，它试图描述数据词汇表和opengraph到schema.org之间的转换:#SchemaXtoschema.orgconversion#data-vocabularyDV:name:namestreet-address:streetAddressregion:addressRegionlocality:addressLocalityphoto:i

  4. ruby - 使用 C 扩展开发 ruby​​gem 时，如何使用 Rspec 在本地进行测试？ - 2

    我正在编写一个包含C扩展的gem。通常当我写一个gem时，我会遵循TDD的过程，我会写一个失败的规范，然后处理代码直到它通过，等等......在“ext/mygem/mygem.c”中我的C扩展和在gemspec的“扩展”中配置的有效extconf.rb，如何运行我的规范并仍然加载我的C扩展？当我更改C代码时，我需要采取哪些步骤来重新编译代码？这可能是个愚蠢的问题，但是从我的gem的开发源代码树中输入“bundleinstall”不会构建任何native扩展。当我手动运行rubyext/mygem/extconf.rb时，我确实得到了一个Makefile(在整个项目的根目录中)，然后当

  5. ruby-on-rails - 项目升级后 Pow 不会更改 ruby​​ 版本 - 2

    我在我的Rails项目中使用Pow和powifygem。现在我尝试升级我的ruby​​版本(从1.9.3到2.0.0，我使用RVM)当我切换ruby​​版本、安装所有gem依赖项时，我通过运行railss并访问localhost:3000确保该应用程序正常运行以前，我通过使用pow访问http://my_app.dev来浏览我的应用程序。升级后，由于错误Bundler::RubyVersionMismatch:YourRubyversionis1.9.3,butyourGemfilespecified2.0.0，此url不起作用我尝试过的:重新创建pow应用程序重启pow服务器更新战俘

  6. ruby-on-rails - 新 Rails 项目 : 'bundle install' can't install rails in gemfile - 2

    我已经像这样安装了一个新的Rails项目:$railsnewsite它执行并到达:bundleinstall但是当它似乎尝试安装依赖项时我得到了这个错误Gem::Ext::BuildError:ERROR:Failedtobuildgemnativeextension./System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/bin/rubyextconf.rbcheckingforlibkern/OSAtomic.h...yescreatingMakefilemake"DESTDIR="cleanmake"DESTDIR="

  7. Ruby Sinatra 配置用于生产和开发 - 2

    我已经在Sinatra上创建了应用程序，它代表了一个简单的API。我想在生产和开发上进行部署。我想在部署时选择，是开发还是生产，一些方法的逻辑应该改变，这取决于部署类型。是否有任何想法，如何完成以及解决此问题的一些示例。例子:我有代码get'/api/test'doreturn"Itisdev"end但是在部署到生产环境之后我想在运行/api/test之后看到ItisPROD如何实现？ 最佳答案 根据SinatraDocumentation:EnvironmentscanbesetthroughtheRACK_ENVenvironm

  8. ruby - 是否可以覆盖 gemfile 进行本地开发？ - 2

    我们的git存储库中目前有一个Gemfile。但是，有一个gem我只在我的环境中本地使用(我的团队不使用它)。为了使用它，我必须将它添加到我们的Gemfile中，但每次我checkout到我们的master/dev主分支时，由于与跟踪的gemfile冲突，我必须删除它。我想要的是类似Gemfile.local的东西，它将继承从Gemfile导入的gems，但也允许在那里导入新的gems以供使用只有我的机器。此文件将在.gitignore中被忽略。这可能吗？ 最佳答案 设置BUNDLE_GEMFILE环境变量:BUNDLE_GEMFI

  9. ruby - 在 Windows 机器上使用 Ruby 进行开发是否会适得其反？ - 2

    这似乎非常适得其反，因为太多的gem会在window上破裂。我一直在处理很多mysql和ruby​​-mysqlgem问题(gem本身发生段错误，一个名为UnixSocket的类显然在Windows机器上不能正常工作，等等)。我只是在浪费时间吗？我应该转向不同的脚本语言吗？ 最佳答案 我在Windows上使用Ruby的经验很少，但是当我开始使用Ruby时，我是在Windows上，我的总体印象是它不是Windows原生系统。因此，在主要使用Windows多年之后，开始使用Ruby促使我切换回原来的系统Unix，这次是Linux。Rub

  10. ruby-on-rails - 在 Rails 开发环境中为 .ogv 文件设置 Mime 类型 - 2

    我正在玩HTML5视频并且在ERB中有以下片段:mp4视频从在我的开发环境中运行的服务器很好地流式传输到chrome。然而firefox显示带有海报图像的视频播放器，但带有一个大X。问题似乎是mongrel不确定ogv扩展的mime类型，并且只返回text/plain，如curl所示:$curl-Ihttp://0.0.0.0:3000/pr6.ogvHTTP/1.1200OKConnection:closeDate:Mon,19Apr201012:33:50GMTLast-Modified:Sun,18Apr201012:46:07GMTContent-Type:text/plain

随机推荐