Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • A azeero.group
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 40
    • Issues 40
    • List
    • Boards
    • Service Desk
    • Milestones
  • Deployments
    • Deployments
    • Releases
  • Packages & Registries
    • Packages & Registries
    • Infrastructure Registry
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Oliver
  • azeero.group
  • Issues
  • #49

Closed
Open
Created Nov 08, 2018 by Jonas Schaltegger@JonirasContributor

Dokumentation der Server-API mittels apidocjs

Es wäre für zukünftige Erweiterungen oder gar Entwickler eine große Hilfe wenn eine Dokumentation des Server vorliegen würde.
Der Server ist zwar bereits in API-Kategorien unterteilt und man sieht jeweils welche Anfrage welchen Typ zurück gibt, jedoch wäre eine solche Dokumentation um weiten übersichtlicher.

Als Demo habe ich die API /ProductCategories mit dem Tool http://apidocjs.com/ dokumentiert. Das Ergebnis ist als Bild im Anhang.

Geschätzter Zeitaufwand:
Aktuelle Anzahl an verschiedenen Requests: 92 Zeitaufwand pro Request: 2-5 Minuten Ergibt: 3 - 6 Stunden

screencapture-localhost-63342-server-apidoc-index-html-2018-11-08-11_06_23

Assignee
Assign to
Time tracking