Je crée le frontal pour un service Web et une autre société pour le back-end. J'ai besoin d'un moyen simple, simple et facilement compréhensible de faire un document d'appels API sur lequel nous pouvons collaborer et éditer ensemble sans se confondre.Bons exemples/modèles/meilleures pratiques Documentation API
Y a-t-il de bonnes spécifications/exemples, etc. de la documentation de l'API du projet, donc cela ne se gâte pas avec beaucoup de réécritures?
semble intéressant, mais trop lourd sur le côté python à mon goût car je n'ai aucune influence sur le python et j'ai besoin de faire mes propres changements et suggestions aussi. – longstaff
@shortstick; Vous n'avez pas besoin de faire de codage python. Il suffit d'installer Sphinx et il vous suffit d'écrire un balisage. Pas de python du tout. – Tauquir
Sphinx a l'air de fonctionner plutôt bien, alors je vais vous donner le coup pour celui-là. Merci! – longstaff
Pour les petites API, j'ai commencé à utiliser Google Docs. Ses fonctionnalités de collaboration sont impressionnantes et vous pouvez voir une liste de toutes les modifications apportées à ce document.
L'intégralité de la bibliothèque Python est un bon exemple de documentation d'API de projet. Il semble que vous commenciez simplement ici. http://docs.python.org/library/. Quel est le problème avec l'utilisation de ce que vous avez déjà comme exemple? –
Juste pour être complet, je suppose que le backend sera écrit en Python. Les balises que vous utilisez indiquent cela, mais vous ne le dites pas explicitement. –
@MortenSiebuhr Oui, c'est vrai, mais je ne pensais pas que c'était si important car je n'ai aucune connaissance de Python en tant que langage et je dois encore contribuer à la façon dont l'API devrait fonctionner. – longstaff