haskell-servant/servant

Want to add my servant example for versioned APIs and partial client implementations

Open

#605 创建于 2016年9月26日

在 GitHub 查看
 (13 评论) (0 反应) (0 负责人)Haskell (1,953 star) (422 fork)batch import
documentationhelp wanted

描述

@fisx @soenkehahn

A few people I've spoken to didn't realize you could do a versioned API or have a partial client implementation in Servant. I didn't either, but I took a look at it with @fisx and it's quite easy. I thought it would be worth having an example project in haskell-servant and linking to it in the Servant documents. I already have a working example project with tests. If you are willing to add it I'll clean the package up and add a more documentation.

https://github.com/mchaver/example-servant-partial-client

贡献者指南

技术栈
无
领域
apidocumentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Basic Haskell knowledgeFamiliarity with ServantUnderstanding of versioned APIs
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
30
研究方向
Review the existing example project at https://github.com/mchaver/example servant partial client. Check the comments on this issue for any feedback from maintainers. Clean up the package, add documentation, and create a pull request to add the example to the haskell servant repository. Ensure the example demonstrates versioned APIs and partial client implementations clearly.