Dokumentacja API i Portal Dewelopera (OpenAPI 3.0)

Nasze API REST rozrosło się do ponad czterdziestu punktów końcowych, a żaden z nich nie jest dziś udokumentowany. Deweloperzy, którzy integrują się z nami, w zasadzie inżynierują wstecz logikę API na podstawie przykładów żądań — to spowalnia proces i generuje lawinę pytań wsparcia. Chcemy dokładnie rozwiązać ten problem i zlecić stworzenie pełnej specyfikacji OpenAPI 3.0 wraz z dopracowanym portalem dewelopera, gdzie dokumentacja może być zarówno czytana, jak i testowana na żywo.

Potrzebujemy wykonawcy, który łączy silne umiejętności pisania technicznego z rzeczywistym doświadczeniem w API, ponieważ zadanie dotyczy zarówno jasnego wyjaśnienia, jak i precyzyjnych schematów. Musimy przygotować kompletną specyfikację YAML OpenAPI 3.0 dla wszystkich punktów końcowych — z schematami żądań i odpowiedzi oraz kodami błędów — a następnie przekształcić ją w interaktywną dokumentację w Swagger UI lub Redoc. Oprócz odniesienia potrzebujemy przewodnika „Jak zacząć”, który obejmie uwierzytelnianie, limity, paginację i obsługę błędów, a także gotowe przykłady kodu w cURL, PHP i JavaScript dla każdego kluczowego punktu końcowego. Kolekcja Postman i szablon changelogu dopełniają całości.

Zapewniamy dostęp do API, wewnętrzną dokumentację kodu i kompletną listę punktów końcowych; oczekujemy gotowej dokumentacji w ciągu 21 dni.

Wynik:
— 1. Specyfikacja YAML OpenAPI 3.0 — wszystkie punkty końcowe, schematy żądań/odpowiedzi, kody błędów
— 2. Interaktywna dokumentacja (Swagger UI lub Redoc)
— 3. Jak zacząć — uwierzytelnianie, limity, paginacja, błędy
— 4. Przykłady kodu — cURL, PHP, JS dla każdego kluczowego punktu końcowego
— 5. Szablon changelogu
— 6. Kolekcja Postman

Proces:
— Zapewniamy: dostęp do API, dokumentację kodu, listę punktów końcowych
— Ty: kompletna dokumentacja w ciągu 21 dni