託管API時有什麼需要記住的嗎？

我已經創建了一個專門的和廣泛的jQuery應用程序來幫助我開發網頁，並且我決定將它發佈到世界上，任何人都想要使用它。託管API時有什麼需要記住的嗎？

我想將它保存爲一個可熱連接的API，但界面使用了一些圖形，所以基本上，我的.js文件和圖像全部坐在我的服務器上的一個公共目錄中。

我的意思是，它的工作原理，我的其他目錄是安全的，但我只想知道，如果還有什麼我應該做的？

來源

2013-08-16 Starkers

提供縮小的版本，你的圖像組合成一個精靈（如果可能的話）並託管到一個CDN。 – Blender

還至少要製作一個小文檔來說明如何使用你的api。許多開發人員（包括我自己）傾向於使用最好的記錄解決方案。 – nanoquack

如果你看到你的項目將來會擴展，版本控制它，並使用諸如GitHub之類的公共站點來託管它。另外，請提供RestructuredText格式的文檔，以便它可以很容易地翻譯並在Wiki中使用等。 –

我創建了一個專門的和廣泛的jQuery應用程序來幫助我開發的網頁，我已經決定櫃面任何人想做出一些利用它來釋放它向世界。

太棒了 - 世界很喜歡分享。爲什麼不能版本控制您的程序並將其託管在諸如GitHub之類的站點上。這通常是傳播知名度的好方法，你會發現人們會把你的節目帶到更高的水平。

我想將它保存爲一個可熱連接的API，但界面使用了一些圖形，所以基本上，我的.js文件和圖像全部坐在我的服務器上的一個公共目錄中。

甜。嘗試使用內容傳送網絡作爲主機，以實現方便快捷的訪問。有一些免費的解決方案，如CDNJS，你可以添加你的插件。

提供精縮替代（Google Closure如能提供極致優化真的很有用），如果你使用大量的圖片，確保他們的壓縮和精靈。你說你的應用程序使用jQuery，但如果它有其他依賴關係，請將其清除。

雖然它需要大量的工作，有能力定製一個插件，讓你只下載你需要的是一個真正偉大的功能，大項目，如Bootstrap和Initializr使用了許多的快樂。如果你是盜鏈的，這可能不是那麼可行，但對於一般的插件來說，這是一個非常棒的功能。

最後，文檔是促進您的工作必須的。沒有它，你的項目通常會死在水中。 GitHub等網站在託管文檔方面非常出色，我會向您指出諸如Select2這樣的項目，演示如何正確完成文檔。如果您打算在各個平臺上提供文檔，請考慮使用RestructuredText，因爲它可以輕鬆地在終端中閱讀，並且可以非常輕鬆地進行格式化。

感謝@Blender和@nanoquack徵求他們的意見

來源

2013-08-17 13:34:46

託管API時有什麼需要記住的嗎？

回答

相關問題