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.
Want to add my servant example for versioned APIs and partial client implementations · haskell-servant/servant#605 | Good First Issue