2013-08-16 12 views
5

Ich habe eine spezialisierte und umfangreiche Jquery-Anwendung erstellt, die mir bei der Entwicklung von Webseiten hilft, und ich habe mich entschlossen, sie in der Welt zu veröffentlichen, wenn irgendjemand sie nutzen möchte.Ist beim Hosten einer API etwas zu beachten?

Ich möchte es als eine hotlinkable API speichern, aber die Schnittstelle verwendet einige Grafiken, also habe ich im Grunde die .js-Datei und die Bilder alle in einem öffentlichen Verzeichnis auf meinem Server.

Ich meine, es funktioniert, und meine anderen Verzeichnisse sind sicher, aber ich will nur wissen, ob ich noch etwas tun sollte?

+4

verkleinerte Versionen bieten, kombinieren Sie Ihre Bilder in einem Sprite (wenn möglich) und Host es auf einem CDN. – Blender

+2

Machen Sie auch mindestens eine kleine Dokumentation, wie Sie Ihre API verwenden. Viele Entwickler (einschließlich mir selbst) neigen dazu, die am besten dokumentierte Lösung zu verwenden. – nanoquack

+0

Wenn Sie sehen, dass Ihr Projekt in der Zukunft expandiert, wird es von der Versionskontrolle gesteuert und über eine öffentliche Site wie GitHub gehostet. Stellen Sie Ihre Dokumentation auch im RestructuredText-Format zur Verfügung, so dass sie leicht übersetzt und in den Wikis usw. verwendet werden kann. –

Antwort

2

Ich habe eine spezialisierte und umfangreiche JQuery-Anwendung erstellt, die mir hilft, Webseiten zu entwickeln, und ich habe mich entschlossen, sie in der Welt zu veröffentlichen, da sonst jeder sie nutzen möchte.

Großartig - Die Welt liebt es zu teilen. Warum nicht Versionskontrolle Ihr Programm und hosten Sie es auf einer Website wie GitHub. Es ist oft ein guter Weg, um Popularität zu verbreiten, und Sie werden feststellen, dass Menschen Ihr Programm auf eine neue Ebene der Größe bringen werden.

Ich möchte es als eine hotlinkable API speichern, aber die Schnittstelle verwendet einige Grafiken, also habe ich im Grunde genommen die .js-Datei und die Bilder in einem öffentlichen Verzeichnis auf meinem Server.

Süß. Versuchen Sie es mit einem Content-Delivery-Netzwerk für Host für einfachen und schnellen Zugriff ermöglichen. Es gibt einige kostenlose Lösungen wie CDNJS, denen Sie Ihr Plugin hinzufügen können.

Geben minimierte Alternativen (Google Closure könnte bei der Bereitstellung extreme Optimierung wirklich nützlich sein), und wenn Sie viele Bilder verwenden, stellen Sie sicher, dass sie komprimiert und in Sprites. Sie sagen, Sie sind Anwendung verwendet jQuery, aber wenn es eine andere Abhängigkeiten hat, machen Sie sie klar.

Obwohl es eine Menge Arbeit, die Fähigkeit, mit anpassen ein Plugin, so dass Sie nur herunterladen, was Sie brauchen, ist ein wirklich großartiges Feature, dass großes Projekt wie Bootstrap und Initializr Verwendung zur Freude viele. Wenn Sie eine Hotlink-Funktion verwenden, ist dies möglicherweise nicht möglich, aber für Plugins ist es im Allgemeinen eine wirklich nette Funktion.

Schließlich Dokumentation ist ein Muss bei der Förderung Ihrer Arbeit. Ohne es ist Ihr Projekt normalerweise tot im Wasser. Websites wie GitHub sind wieder wirklich gut darin, Dokumentation zu hosten, und ich würde Sie auf Projekte wie Select2 hinweisen, die zeigen, wie Dokumentation richtig gemacht werden kann. Wenn Sie planen, Ihre Dokumentation plattformübergreifend verfügbar zu haben, sollten Sie auch RestructuredText verwenden, da diese Terminals einfach zu lesen sind und sehr einfach formatiert werden können.

Dank @Blender und @nanoquack für ihre Eingabe

Verwandte Themen