Projektbeschreibung
ÜbersetztUnsere REST-API ist auf mehr als vierzig Endpunkte gewachsen und bisher ist keiner von ihnen dokumentiert. Entwickler, die sich mit uns integrieren, reverse-engineeren effektiv die API aus Beispielanfragen, was alle verlangsamt und einen stetigen Strom vermeidbarer Supportfragen erzeugt. Wir möchten das richtig beheben, indem wir eine vollständige OpenAPI 3.0-Spezifikation in Auftrag geben, zusammen mit einem ausgefeilten Entwicklerportal, das die Leute tatsächlich lesen und ausprobieren können.
Wir suchen jemanden, der starkes technisches Schreiben mit echter praktischer API-Erfahrung kombiniert, denn dieser Job geht sowohl um klare Erklärungen als auch um genaue Schemata. Sie werden eine vollständige OpenAPI 3.0 YAML-Spezifikation erstellen, die jeden Endpunkt, seine Anfrage- und Antwortschemata sowie seine Fehlercodes abdeckt, und diese dann in interaktive Dokumente umwandeln, die mit Swagger UI oder Redoc gehostet werden. Darüber hinaus benötigen wir einen Leitfaden zum Einstieg, der die Authentifizierung, Ratenlimits, Paginierung und Fehlerbehandlung erklärt, sowie Copy-Paste-Codebeispiele in cURL, PHP und JavaScript für jeden wichtigen Endpunkt. Runden Sie es mit einer Postman-Sammlung und einer Änderungsprotokollvorlage für die Versionshistorie ab.
Wir stellen API-Zugriff, unsere bestehenden internen Code-Dokumente und die vollständige Endpunktliste zur Verfügung; wir erwarten die fertige Dokumentation innerhalb von einundzwanzig Tagen.
Liefergegenstände:
— 1. OpenAPI 3.0 YAML-Spezifikation — alle Endpunkte, Anfrage-/Antwortschemata, Fehlercodes
— 2. Interaktive API-Dokumente — gehostete Seite mit Swagger UI oder Redoc
— 3. Leitfaden zum Einstieg — Authentifizierung, Ratenlimits, Paginierung, Fehler
— 4. Codebeispiele — cURL, PHP, JavaScript für jeden wichtigen Endpunkt
— 5. Änderungsprotokoll — Vorlage für die Versionshistorie
— 6. Postman-Sammlungsexport
Prozess:
— Wir stellen zur Verfügung: API-Zugriff, bestehende Codebasis-Dokumente, Endpunktliste
— Sie liefern: vollständige Dokumente in 21 Tagen
— Starkes technisches Schreiben sowie API-Erfahrung erforderlich
Wir suchen jemanden, der starkes technisches Schreiben mit echter praktischer API-Erfahrung kombiniert, denn dieser Job geht sowohl um klare Erklärungen als auch um genaue Schemata. Sie werden eine vollständige OpenAPI 3.0 YAML-Spezifikation erstellen, die jeden Endpunkt, seine Anfrage- und Antwortschemata sowie seine Fehlercodes abdeckt, und diese dann in interaktive Dokumente umwandeln, die mit Swagger UI oder Redoc gehostet werden. Darüber hinaus benötigen wir einen Leitfaden zum Einstieg, der die Authentifizierung, Ratenlimits, Paginierung und Fehlerbehandlung erklärt, sowie Copy-Paste-Codebeispiele in cURL, PHP und JavaScript für jeden wichtigen Endpunkt. Runden Sie es mit einer Postman-Sammlung und einer Änderungsprotokollvorlage für die Versionshistorie ab.
Wir stellen API-Zugriff, unsere bestehenden internen Code-Dokumente und die vollständige Endpunktliste zur Verfügung; wir erwarten die fertige Dokumentation innerhalb von einundzwanzig Tagen.
Liefergegenstände:
— 1. OpenAPI 3.0 YAML-Spezifikation — alle Endpunkte, Anfrage-/Antwortschemata, Fehlercodes
— 2. Interaktive API-Dokumente — gehostete Seite mit Swagger UI oder Redoc
— 3. Leitfaden zum Einstieg — Authentifizierung, Ratenlimits, Paginierung, Fehler
— 4. Codebeispiele — cURL, PHP, JavaScript für jeden wichtigen Endpunkt
— 5. Änderungsprotokoll — Vorlage für die Versionshistorie
— 6. Postman-Sammlungsexport
Prozess:
— Wir stellen zur Verfügung: API-Zugriff, bestehende Codebasis-Dokumente, Endpunktliste
— Sie liefern: vollständige Dokumente in 21 Tagen
— Starkes technisches Schreiben sowie API-Erfahrung erforderlich
Texte und Übersetzung Bargeld, Banküberweisung
