Wiki-Software zum Dokumentieren von APIs

Was ist eine empfohlene Art der Dokumentation und Freigabe von APIs (z. B. HTTP-Web-Services)?Wiki-Software zum Dokumentieren von APIs

Die Anforderungen sind:

Ein Wiki Typ-System, in dem jeder jede Seite ändern können.
Eine einfache Möglichkeit, eine API spec zu schreiben, so dass das Styling/Formatierung automatisch angelegt wird, statt eines manuellen Styling für jede einzelne Seite hinzufügen zu müssen.

Ich würde Wordpress verwenden, außer dass es nicht wirklich ein Wiki-System ist; es ist eher eine Blog-Engine. Ich möchte eine nette, saubere, strukturierte Hierarchie von Seiten, und die Fähigkeit klicken und bearbeiten sofort.

Ich versuchte Google Sites, aber das scheint auch ungeeignet, weil es mir nicht erlaubt, einen einheitlichen Stil für APIs zu erstellen. Die einzige Kontrolle, die ich über das Styling habe, sind "Themen", die das Aussehen der gesamten Seite verändern und nicht spezifisch genug sind.

fand ich einen hosted solution here, aber bei $ 499 p/Jahr bin ich sicher, dass wir es besser machen können.

Irgendwelche Vorschläge?

Quelle

2010-12-02 Jonathan

+1 sind zu fragen. Ich habe hier eine ähnliche Frage gestellt: http://stackoverflow.com/questions/3129729/, und bekam nie eine befriedigende Antwort. – Yahel

könnte mit so etwas wie doxygen betrachten eine inital Snapshot zu erzeugen, und dann, dass nur wikify.

Quelle

2010-12-02 02:34:30

Wäre elegant, würde aber in diesem speziellen Szenario nicht funktionieren, da wir keine Kontrolle über den Code für die Back-End-Webdienste haben. Wir entwickeln nur das Front-End dieses Systems. – Jonathan

Wäre nicht notwendig, den tatsächlichen Back-End-Code unbedingt zu haben. Könnte Stubs in etwas wie Python oder einer anderen doxygen-kompatiblen Sprache codieren. –

Viele Projekte verwenden trac. Hier ist ein Beispiel für ein Projekt, das es verwendet http://djangobb.org/wiki

Trac integriert zusammen Wiki, Issue-Tracking und Quellcodeverwaltung.

Quelle

2010-12-02 02:39:20 cababunga

+1 Trac, es ist großartig. Obwohl ich das richtige Mediawiki-Markup vermisse. –

Trac würde den Job machen, aber ich habe gehört, dass es ein bisschen ein Biest in Bezug auf Komplexität ist. – Jonathan

Nicht sicher, warum die Leute das sagen würden. Nach meiner Erfahrung ist es einfach, Mercurial oder Subversion einzurichten und zu integrieren. Nutzung und Administration sind ebenfalls sehr einfach. – cababunga

Eine ähnliche Frage wurde hier auch gepostet: Wiki solution for APIs documentations?

und ich schlug mit MindTouch

** jonathan, sah nur Ihre Kommentare über trac zu viel Komplexität hinzuzufügen. Sie werden wahrscheinlich das gleiche mit Mindtouch zu finden, aber das ist, weil sie eine Lösung für ein bestimmtes Problem, und die geeigneten Werkzeuge zur Verfügung, bieten viel mehr Möglichkeiten (dh Komplexität)

Quelle

2010-12-17 20:51:47 GrandVizier

Wiki-Software zum Dokumentieren von APIs

Antwort

Verwandte Themen