托管API时有什么需要考虑的吗?

时间:2013-08-16 19:46:56

标签: jquery api

我已经创建了一个专门的,广泛的jquery应用程序来帮助我开发网页,我决定将它发布到世界上,任何其他人都想要使用它。

我想将它保存为可链接的API,但界面使用了一些图形,所以基本上,我有.js文件和图像都位于我服务器上的一个公共目录中。

我的意思是它有效,而我的其他目录是安全的,但我只是想知道我还有什么别的吗?

1 个答案:

答案 0 :(得分:2)

  

我已经创建了一个专门的,广泛的jquery应用程序来帮助我开发网页,我决定将它发布到世界上,任何其他人都想要使用它。

伟大 - 世界喜欢分享。为什么不版本控制您的程序并将其托管在GitHub等网站上。它通常是传播人气的好方法,你会发现人们会把你的程序提升到新的水平。

  

我想将它保存为可链接的API,但界面使用了一些图形,所以基本上,我有.js文件和图像都位于我服务器上的一个公共目录中。

甜。尝试使用内容交付网络来托管,以便轻松快速地访问。有一些免费的解决方案,例如你可以添加插件的CDNJS

提供缩小的替代Google Closure在提供极端优化方面可能非常有用),如果您使用大量图片,请确保它们已经压缩并且精灵。你说你的应用程序使用jQuery,但如果它有其他依赖项,请明确它们。

虽然需要做很多工作,但能够自定义一个插件才能只下载你需要的内容,这是一个非常棒的功能,如Bootstrap和{ {3}}使用许多人的快乐。如果你是热链接,这可能不太可行,但对于插件来说,这是一个非常好的功能。

最后,文档是推广工作的必要条件。没有它,你的项目通常死在水中。像GitHub这样的网站再次非常擅长托管文档,我会指向Initializr之类的项目,这些项目演示了如何正确地完成文档。如果您计划跨平台提供文档,请考虑使用RestructuredText,因为它易于在终端中阅读,并且可以非常容易地进行格式化。

感谢@Blender和@nanoquack的输入