Hallo,
ich entwickle gerade etwas mit Restful.
Dabei habe ich vor mich Streng an die Regeln zu halte.
Heißt:
Ich nutze GET, PUT,POST,DELTE . --> Macht die Sache erstmal undurchsichtig, wenn man von außen auf solch einen API schaurt.
Deshalb würde ich diese API auch gerne Dokumentieren.
Leider bietet Restful anscheinden keine Möglichkeit die "Rest"-Klassen/Methoden zu dokumentieren.
Könnt ihr mich aufklären?
Dokumentiert ihr eure Restful APIs nur von Hand oder nutzt ihr Tools die, die Kommentare der Klassen und Methoden erkennen und den Aufbau der Benötigten Anfrage z.B.: bei POST mit variabeln Dokumentieren.
Ein Beispiel :
URL Anfrage : http://url.de/restapi/mitarbeiter
Dokumentation:
GET: mitarbeiter/{id} --> Liefert die den Mitarbeiter mit der ensprechenden ID zurueck wenn # werden alle zureuckgeliefert
PUT: mitarbeiter --> Legt einen neuen Mitarbeiter an oder updatet ihn (Wenn ID mit übergeben wird).
Parameter: id, name, alter, tel
So in der Art meinte ich das...
Gibt es da etwas das mir sowas anfertigt. Like Javadoc nur für Restful
ich entwickle gerade etwas mit Restful.
Dabei habe ich vor mich Streng an die Regeln zu halte.
Heißt:
Ich nutze GET, PUT,POST,DELTE . --> Macht die Sache erstmal undurchsichtig, wenn man von außen auf solch einen API schaurt.
Deshalb würde ich diese API auch gerne Dokumentieren.
Leider bietet Restful anscheinden keine Möglichkeit die "Rest"-Klassen/Methoden zu dokumentieren.
Könnt ihr mich aufklären?
Dokumentiert ihr eure Restful APIs nur von Hand oder nutzt ihr Tools die, die Kommentare der Klassen und Methoden erkennen und den Aufbau der Benötigten Anfrage z.B.: bei POST mit variabeln Dokumentieren.
Ein Beispiel :
URL Anfrage : http://url.de/restapi/mitarbeiter
Dokumentation:
GET: mitarbeiter/{id} --> Liefert die den Mitarbeiter mit der ensprechenden ID zurueck wenn # werden alle zureuckgeliefert
PUT: mitarbeiter --> Legt einen neuen Mitarbeiter an oder updatet ihn (Wenn ID mit übergeben wird).
Parameter: id, name, alter, tel
So in der Art meinte ich das...
Gibt es da etwas das mir sowas anfertigt. Like Javadoc nur für Restful