基于类型安全的API定义库:Typedapi
2024-06-07 08:32:40作者:范靓好Udolf
*.Typedapi 是一个实验性的开源项目,它允许你在Scala中定义类型安全的API,并且利用编译器来确保你的代码与API规范完全符合。这个库深受Haskell-Servant的影响,但其设计目标是独立于任何特定的服务器或客户端实现。
项目介绍
在Typedapi中,你可以通过简单的DSL(领域特定语言)定义API接口,包括HTTP方法、路径和查询参数。定义完成后,library会自动生成相应的客户端和服务端代码,无需额外的宏或者手动编写函数。以下是一个简单的例子:
val MyApi = 
  // GET /fetch/user?name={String} 
  := > "fetch" :> "user" :> Query[String]('name) :> Get[MT.`application/json`, User] :|:
  // POST /create/user
  := > "create" :> "user" :> ReqBody[Json, User] :> Post[MT.`application/json`, User]
从上述代码中,我们可以看到如何优雅地定义一个包含两个端点(获取用户信息和创建新用户)的API。
项目技术分析
Typedapi的核心是它的类型系统。通过对API进行类型化编码,它能捕捉到许多潜在的错误,如不正确的请求格式、缺失的参数等。这意味着在运行时,由于类型错误导致的问题将大大减少。
此外,它支持多种后端框架,如http4s、akka-http以及Scalaj-Http(仅限客户端),并且可以扩展到其他框架。对于客户端,还提供了ScalaJS的支持,使你能够在前端应用中直接使用定义好的API。
项目及技术应用场景
适用于任何需要构建类型安全的RESTful API的场景,无论是大型的企业级应用还是小型的个人项目。例如:
- 在微服务架构中,每个服务都可以通过定义其API并自动生成客户端和服务端代码,简化开发过程。
- 对于前端开发者,通过ScalaJS版本的Typedapi,可以直接在浏览器环境中调用后端API,而不用担心类型转换问题。
项目特点
- 类型安全:所有API调用都被编译器检查,确保了类型的一致性。
- DSL定义:直观易懂的DSL,使得API定义清晰简洁。
- 多平台支持:涵盖Scala 2.11、2.12和ScalaJS,兼容http4s、akka-http等多种框架。
- 自动生成代码:基于API定义,自动生成客户端和服务器端的实现。
- 易于扩展:提供编写自定义客户端后端的文档,满足不同需求。
要开始使用Typedapi,只需将相关依赖添加到你的项目中,并按照示例代码进行尝试。详细的文档涵盖了从API定义、客户端创建到服务器端实现的所有步骤,确保你可以快速上手。
总的来说,Typedapi是构建类型安全、高效且可维护的API的强大工具,无论你是新手还是经验丰富的开发者,都值得将其纳入你的工具箱。立即尝试,感受它带来的便利吧!
登录后查看全文 
热门项目推荐
 PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00 PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
- DDeepSeek-OCRDeepSeek-OCR是一款以大语言模型为核心的开源工具,从LLM视角出发,探索视觉文本压缩的极限。Python00
 openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00 openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
 HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00 HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
 AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03 AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
 Spark-Scilit-X1-13B科大讯飞Spark Scilit-X1-13B基于最新一代科大讯飞基础模型,并针对源自科学文献的多项核心任务进行了训练。作为一款专为学术研究场景打造的大型语言模型,它在论文辅助阅读、学术翻译、英语润色和评论生成等方面均表现出色,旨在为研究人员、教师和学生提供高效、精准的智能辅助。Python00 Spark-Scilit-X1-13B科大讯飞Spark Scilit-X1-13B基于最新一代科大讯飞基础模型,并针对源自科学文献的多项核心任务进行了训练。作为一款专为学术研究场景打造的大型语言模型,它在论文辅助阅读、学术翻译、英语润色和评论生成等方面均表现出色,旨在为研究人员、教师和学生提供高效、精准的智能辅助。Python00
 GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00 GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00
- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile014
 Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00 Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
 docs
docsOpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
261
2.52 K
 kernel
kerneldeepin linux kernel
C
24
6
 flutter_flutter
flutter_flutter暂无简介
Dart
553
123
 ops-math
ops-math本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
595
131
 pytorch
pytorchAscend Extension for PyTorch
Python
94
121
 cangjie_tools
cangjie_tools仓颉编程语言命令行工具,包括仓颉包管理工具、仓颉格式化工具、仓颉多语言桥接工具及仓颉语言服务。
C++
52
67
 ohos_react_native
ohos_react_nativeReact Native鸿蒙化仓库
JavaScript
218
301
 RuoYi-Vue3
RuoYi-Vue3🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.02 K
600
 cangjie_compiler
cangjie_compiler仓颉编译器源码及 cjdb 调试工具。
C++
116
90
 Cangjie-Examples
Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
357
1.77 K