API-Dokumentation und Entwicklerportal (OpenAPI 3.0)

Unsere REST-API ist auf über vierzig Endpunkte angewachsen, und keiner von ihnen ist heute dokumentiert. Entwickler, die sich mit uns integrieren, reverse-engineeren im Wesentlichen die API-Logik aus Anfragebeispielen – das verlangsamt die Dinge und führt zu einer Flut von Supportfragen. Wir möchten dieses Problem gründlich lösen und eine vollständige OpenAPI 3.0-Spezifikation in Auftrag geben, zusammen mit einem ausgefeilten Entwicklerportal, in dem die Dokumentation sowohl gelesen als auch live getestet werden kann.

Wir benötigen einen Ausführer, der starkes technisches Schreiben mit echter API-Erfahrung kombiniert, da die Aufgabe sowohl klare Erklärungen als auch präzise Schemata umfasst. Wir müssen eine vollständige YAML OpenAPI 3.0-Spezifikation für alle Endpunkte vorbereiten – mit Anfrage- und Antwortschemata sowie Fehlercodes – und sie dann in interaktive Dokumentation in Swagger UI oder Redoc umwandeln. Neben dem Referenzdokument benötigen wir einen Leitfaden zum Einstieg, der Authentifizierung, Ratenlimits, Paginierung und Fehlerbehandlung abdeckt, sowie fertige Codebeispiele in cURL, PHP und JavaScript für jeden wichtigen Endpunkt. Eine Postman-Sammlung und eine Änderungsprotokollvorlage runden das Bild ab.

Wir bieten API-Zugang, interne Code-Dokumentation und eine vollständige Liste von Endpunkten; wir erwarten die fertige Dokumentation innerhalb von 21 Tagen.

Ergebnis:
— 1. OpenAPI 3.0 YAML-Spezifikation — alle Endpunkte, Anfrage-/Antwortschemata, Fehlercodes
— 2. Interaktive Dokumentation (Swagger UI oder Redoc)
— 3. Einstiegshandbuch — Authentifizierung, Limits, Paginierung, Fehler
— 4. Codebeispiele — cURL, PHP, JS für jeden wichtigen Endpunkt
— 5. Änderungsprotokollvorlage
— 6. Postman-Sammlung

Prozess:
— Wir bieten: API-Zugang, Code-Dokumentation, Liste der Endpunkte
— Sie: vollständige Dokumentation in 21 Tagen