API-DokumentationTechnische Dokumentation

API-Dokumentation aus Ihren Endpunktbeschreibungen

Lieferung ab 1 TagÜberarbeitungen inklusiveQualitätsprüfung
Pakete
ZahlungsschutzMehr dazu
  • Überarbeitungen im Rahmen des Pakets sind kostenlos.
  • Reagieren Sie nicht innerhalb von 3 Tagen nach der Lieferung, gilt die Arbeit automatisch als abgenommen.
Bestellen · 35 €

Das Geld wird bei der Zahlung reserviert und erst freigegeben, wenn Sie die Arbeit abnehmen.

API-Dokumentation aus Ihren Endpunktbeschreibungen

Beispielergebnis

Beispiel für das Standard-Paket

Arbeitsanweisungen: Öffnen und Schließen eines kleinen Cafés

AA-02: Café schließen

ZweckCafé sauber, sicher und bereit für die Frühschicht hinterlassen
WerSchließende Barista; Schichtleitung zeichnet ab
WannBeginn 17:30 Uhr, Tür zu um 18:00 Uhr, fertig bis 18:45 Uhr
BenötigtCheckliste Schließen, Kassenschlüssel, Putzwagen, blaue Tücher

Vor dem Start

Achtung: Niemals den Hauptschalter im Sicherungskasten ausschalten. Kühlschränke und Alarmanlage hängen am selben Stromkreis.

Schritte

  1. Um 17:30 Uhr das Türschild auf „Letzte Bestellung“ drehen. Gäste, die schon da sind, dürfen bis 18:00 Uhr bleiben.
  2. Kaffeemaschine in den Spülmodus schalten. Tassentaste 5 Sekunden gedrückt halten. Sie sollten sehen: „RINSE“ blinkt im Display, heißes Wasser läuft etwa 2 Minuten durch beide Brühgruppen.
  3. Siebträger herausnehmen und einweichen im schwarzen Behälter mit einer Reinigungstablette. 20 Minuten einwirken lassen.
  4. Kuchen und Sandwiches in den hinteren Kühlschrank stellen. Alles heute Geöffnete mit Datum und „Bis morgen verbrauchen“ beschriften.
  5. Kühlschranktemperaturen eintragen ins Protokoll. Sie sollten sehen: zwischen 1 °C und 5 °C. Liegt ein Kühlschrank über 5 °C, zuerst zu Schritt 12.
  6. Um 18:00 Uhr die Eingangstür abschließen und das Schild auf „Geschlossen“ drehen.
  7. Kasse abschließen. MENU drücken, dann „Tagesabschluss“, dann „Z-Bon“. Sie sollten sehen: der Bon druckt mit der Tagessumme. Bargeld nicht am Tresen zählen; Lade ins Büro bringen.

(Schritte 8–14: Böden, Müll, Alarmanlage und Übergabenotiz.)

Wenn etwas schiefgeht

ProblemWas tun
Kühlschrank über 5 °CWare in den zweiten Kühlschrank, Uhrzeit und Temperatur notieren, Schichtleitung per Nachricht informieren
Z-Bon druckt nichtPapierrolle wechseln; klappt es weiter nicht, Summe vom Bildschirm notieren und fotografieren
Alarm lässt sich nicht scharf schaltenPrüfen, ob die Hintertür ganz zu ist; bei offener Tür schaltet der Alarm nicht scharf

Abzeichnen

Schließende Barista: Name, Uhrzeit. Schichtleitung: Kürzel.

Zuletzt geprüft: [Datum]. Erneut prüfen, wenn Kaffeemaschine oder Kasse ersetzt werden.

Kunde: Café Glockenblume, 22 Plätze, 7 Mitarbeitende im Schichtwechsel Vorlage: Sprachnachrichten der Inhaberin, eine handschriftliche Checkliste und 9 Fotos von Tresen, Kaffeemaschine und Kassenbildschirm Geliefert: 6 Arbeitsanweisungen (4.600 Wörter): Öffnen, Schließen, Kassenführung, Kühlschrank-Temperaturprotokoll, Grundreinigung der Kaffeemaschine, Umgang mit Beschwerden. Unten ein Auszug der Schließanweisung.

Kunde und alle Angaben sind erfunden.

Über diese Leistung

Entwicklerinnen und Entwickler beurteilen eine API innerhalb von Minuten anhand ihrer Dokumentation: Wenn die Authentifizierung oder die erste Anfrage nicht funktioniert, sind sie weg. Wir schreiben API-Referenz und Anleitungen aus Ihren Endpunktbeschreibungen, Ihrer OpenAPI-Datei oder Codebeispielen: Authentifizierung, Basis-URLs, jeder Endpunkt mit Parametern, Beispiele für Anfragen und Antworten, Fehlercodes, Ratenbegrenzungen und Paginierung. Ein Schnellstart zeigt den ersten erfolgreichen Aufruf in wenigen Schritten.

Was enthalten ist

  • Das bekommen SieAPI-Dokumentation als Markdown mit Codeblöcken, bereit für ReadMe, GitBook, Docusaurus oder Ihr Repository. Wir schreiben aus dem, was Sie senden, und rufen Ihre API nicht selbst auf.
  • SchnellstartVom API-Schlüssel zum ersten Aufruf
  • EndpunktreferenzParameter, Typen, Beispiele
  • Fehler und LimitsCodes, Bedeutungen, Hinweise zu Wiederholungen
  • CodebeispielecURL plus eine Sprache Ihrer Wahl
  • Einheitliche BegriffeDieselben Namen wie in Ihrem Schema

So funktioniert es

  1. 1
    BriefingSie fügen Endpunkte und Beispiele ein oder hängen sie an
  2. 2
    Struktur und SchreibenWir schreiben Referenz und Anleitungen
  3. 3
    LieferungSie erhalten Markdown zum Veröffentlichen

Was wir von Ihnen brauchen

Endpunktbeschreibungen oder eine OpenAPI- oder Postman-Datei als eingefügten Text, Details zur Authentifizierung, Beispielanfragen und -antworten, Fehlercodes und wer Ihre API nutzt.

Wir fragen Sie:

  • Was macht die API, und wer nutzt sie?
  • Wie funktioniert die Authentifizierung?
  • Welche Sprache sollen die Codebeispiele neben cURL verwenden?
  • Wo wird die Dokumentation veröffentlicht?

Pakete vergleichen

PaketeBasisSchnellstart und bis zu 5 Endpunkte17 €StandardBis zu 20 Endpunkte mit Anleitungen35 €PremiumBis zu 50 Endpunkte, vollständige Dokumentation70 €
Lieferzeit1 Tag3 Tage5 Tage
Überarbeitungen123
Längebis 2.000 Wörterbis 6.000 Wörterbis 14.000 Wörter
Endpunktebis 5bis 20bis 50
Sprachen der CodebeispielecURLcURL + 1cURL + 2
Bestellen BasisBestellen StandardBestellen Premium

Zahlungsschutz

Sie bezahlen bei der Bestellung, aber das Geld wird nur für abgenommene Arbeit freigegeben.

  • FestpreisDer Paketpreis ändert sich nach der Zahlung nicht mehr.
  • Das Geld wird reserviertBei der Zahlung wird der Betrag nur reserviert. Freigegeben wird er erst, wenn Sie die Arbeit abnehmen.
  • Vor der Lieferung geprüftJedes Ergebnis durchläuft eine Qualitätsprüfung, bevor es Sie erreicht, und Sie sehen es auf der Bestellseite, bevor Sie es abnehmen.
  • Kostenlose ÜberarbeitungenFordern Sie Überarbeitungen im Rahmen Ihres Briefings so oft an, wie das Paket es erlaubt.
  • Abnahme nach 3 TagenWenn Sie die Arbeit innerhalb von 3 Tagen nach der Lieferung weder abnehmen noch eine Überarbeitung anfordern, gilt sie automatisch als abgenommen. Schreiben Sie nach der Lieferung im Bestell-Chat, wartet die Bestellung; sobald wir antworten, können wir die 3 Tage neu starten und teilen das im Chat mit.
  • Neuanfertigung oder volle RückerstattungWenn das Ergebnis nicht Ihrem Briefing entspricht und die Überarbeitungen das nicht behoben haben oder die Arbeit mehr als doppelt so lange dauert wie die Frist, schreiben Sie im Bestell-Chat: Wir erstellen die Arbeit neu oder erstatten die Zahlung vollständig.
So funktioniert es →

Fragen und Antworten

Können Sie mit unserer OpenAPI-Spezifikation arbeiten?

Ja, fügen Sie das YAML oder JSON in das Briefing ein. Wir machen aus den Beschreibungen gut lesbare Referenzseiten und füllen Lücken, auf die Sie hinweisen.

Testen Sie die Beispiele?

Wir rufen Ihre API nicht auf. Die Beispiele entstehen aus Ihren Anfrage- und Antwortbeispielen, führen Sie sie daher vor der Veröffentlichung einmal aus.

Schreiben Sie SDK-Dokumentation?

Ja, wenn Sie die Methodensignaturen und Anwendungsbeispiele senden. Jedes SDK zählt zum Umfang des Pakets.

Pakete
Bestellen · 35 €· 3 Tage