MaikGoertz
commented
3 months ago Hallo Herr Fish.
Danke für Ihr Feedback. Wir möchte unsere Dokumentation selbstverständlich gerne richtig gestalten.
Parameter sind falsch geschrieben(z.B. In Doku:"SetDocumentKindFlag" --> Was die API erwartet: "KindFlag"...wtf)
Wo finden Sie "SetDocumentKindFlag" in der Dokumentation? Ich habe es nicht gefunden.
Bspw. hier: https://demo.slmobile.de/demoApi/Help/Api/POST-Documents heißt es KindFlag.
Requestbeispiele, wie so ein requestheader am Ende wirklich aussehen sollte, sind kaum vorhanden(Wichtig für n00bs)
Das hängt sehr von der gewählten Programmiersprache ab, wie der Header genau definiert werden muss, deswegen haben wir es versucht so allgemein wie möglich zu halten, bspw. hier: https://demo.slmobile.de/demoApi/Help/HowToUse
Die Postmanadaption ist gefühlt ungepflegt seit zwei Jahren
Wir veröffentlichen zu jeder Version, wenn neue Routen hinzu kommen oder alte Route entfernt werden, eine neue Postman Collection. Die letzte Änderungen waren zu Version 23.3.
Die durch Postman generierten Codesnippets sind nicht immer useable, da fehlt es an Unterstützung an allen Ecken; Responses laufen ins Leere mangels Mock files.
Alle unsere Postman Beispiele sind auf dem Mustermandanten "WAWI" lauffähig.
Die zu erwartende Response wird nicht immer richtig benannt- Wie sie aussieht, was sie enthält etc.
Können Sie da konkrete Beispiele nennen? Dann würde wir diese korrigieren, bzw. ergänzen.
Zwingende/optionale Parameter werden nicht sauber aufgelistet, was zu endlosen Frustsessions führt
Auch hier können wir nur mit konkreten Beispielen eine Verbesserung der Dokumentation erreichen.
Gruß Maik
Geoffrey-Fish
Hallo Selectline,
ich muss nun doch mal fragen, ob und wann Ihr eure Dokumentation überarbeitet, denn die ist so, wie Sie ist, nicht gut.
Das sind die Punkte, die mir spontan auf der Seele brennen. Ich weiss jetzt schon, das ich was vergessen habe in der Auflistung.
Ich mag euer Produkt, ich mag den Ansatz weg von der XFakt hin zum 21. Jahrhundert - Aber Ihr macht es einem nicht gerade leicht.
LG
Geoffrey Fish