api-design

2熱度

2回答

我正在處理REST客戶端庫，並且最近開始致力於添加對發送批處理消息的支持。但是，我不喜歡現在的設計。它要求您維護具有相同方法簽名的大型Client和RequestMessage類。我正在尋找一種方法來鞏固這兩個類。原來的客戶端類的方法包含了所有的準備併發送請求所需的代碼： class Client(object): def __init__(self, config):

3熱度

4回答

記錄器方法設計

我正在用C＃編寫一個函數來記錄用戶在我們系統上的操作並將它們保存在數據庫中。具體而言，我想記錄業務邏輯的某些功能，因爲它們被稱爲。我來到約測井方法是這樣的： public static LogMethod(string user, string methodName, object[] parameters, string message) 內適當ToString()函數被調用爲每個參數的方法

0熱度

1回答

用於創建表示樹的節點的對象代表Ruby的父母

我正在研究一個REST API的Ruby綁定，並且正在努力處理其中一部分會被認爲是慣用Ruby的東西。爲了說明一個簡單的例子，通過API代表的資源形成一個樹形結構： root /\ /\ / \ group group / /\ / /\ / / \ project project project 要

5熱度

1回答

應該使用file：protocol從URL讀取的API的默認編碼是什麼？

我正在設計一個API，它將URL作爲輸入，並讀取該URL處的內容。當URL是「file：」協議時，什麼會爲字符編碼提供更好的默認值？系統的本地編碼 UTF-8 API允許這個被明確設置。此外，我們可以使用一些啓發式來確定字符編碼，如可用的BOM，但是當所有這些都失敗時，默認應該是什麼？據我所知，這個標準在這個問題上沒有提及。在其他所有條件都相同的情況下，我希望對於甚至不知道字符編碼等事情的人來

8熱度

1回答

RESTful處理資源之間雙向關係的方式

假設我想要設計一個REST api來討論歌曲，專輯和藝術家（實際上我是這樣做的，就像1312414之前的人一樣）。歌曲資源總是與它所屬的專輯相關聯。相反，專輯資源與其包含的所有歌曲相關聯。這些關聯通過鏈接在資源表示中表達。因此，陳述會是這個樣子： { song: 'xyz', links: [ { rel: 'album', url: '.../albums/a

2熱度

2回答

在API中導出常量的正確方法

以下示例中顯示的兩個解決方案中的哪一個是從我的API（Windows DLL）中導出常量的正確方法，以及爲什麼它是更好的選擇？頭文件 namespace ExampleAPI { // Solution one extern const DWORD __declspec(dllexport) AKTION_OK; extern const DWORD __decl

17熱度

1回答

通過RESTful API中的ID或子彈標識項目

我目前正在設計一個API，並且我遇到了一個小問題： RESTful API的URL應如何看起來像應該能夠通過ID或者slu identify識別物品？我能想到的三個選項： GET /items/<id> GET /items/<slug> 這就要求蛞蝓和ID是可區分的，這是沒有必要在這種情況下給出的。我不認爲這個問題的乾淨的解決方案的，除非你做這樣的事情： GET /items/id/<i

2熱度

3回答

我應該允許實現類在不這樣做的情況下破壞API的可能性會導致不利影響

我正在使用支持ScheduledExecutorService的調度程序的API工作。基本設計是，您使用調度程序註冊提供程序實例，調度程序爲每個註冊的提供程序維護ScheduledFuture。提供者本質上是一個知道如何檢索觸發任務的Runnable。我遇到的問題是取消預定的未來時要做什麼。取消ScheduledFuture的API需要一個布爾參數，以允許正在觸發的Provider中斷。我認爲提

10熱度

1回答

未經檢查的異常本可以更好地檢查

我意識到在檢查異常與Java中的未檢查異常的相對優點上存在beenamplediscussion，我不打算重新審視整個辯論。相反，我想問一個非常具體的問題，因爲我正在閱讀Joshua Bloch的Effective Java，2nd Edition。在我閱讀時，我注意到在第59條（「避免不必要地使用檢查的異常」）中，Joshua在Java API中給出了一個使用了檢查異常的例子。具體而言，在Ob

8熱度

1回答

HATEOAS客戶端設計

我已經閱讀了很多關於SO的討論，觀看了Jon Moore's presentation（它解釋了很多，順便說一句），並閱讀了Roy Fielding在HATEOAS上的博客文章，但對於客戶端，我仍然感覺有點暗淡設計。 API問題現在，我只是用回表格/錨和定義列表代表的資源XHTML。以下片段詳細介紹了我如何佈置表單/錨點/列表。 # anchors <li class='docs_url/#r