Opis projektu
PrzetłumaczoneNasze REST API rozrosło się do ponad czterdziestu punktów końcowych i w tej chwili żaden z nich nie jest udokumentowany. Programiści integrujący się z nami w rzeczywistości odwracają inżynierię API na podstawie przykładowych żądań, co spowalnia wszystkich i generuje stały strumień unikalnych pytań wsparcia. Chcemy to naprawić w odpowiedni sposób, zlecając stworzenie pełnej specyfikacji OpenAPI 3.0 razem z dopracowanym portalem dla programistów, który ludzie mogą rzeczywiście przeczytać i wypróbować.
Szukamy kogoś, kto łączy silne umiejętności pisania technicznego z rzeczywistym doświadczeniem w pracy z API, ponieważ ta praca dotyczy zarówno jasnego wyjaśnienia, jak i dokładnych schematów. Stworzysz pełną specyfikację OpenAPI 3.0 w formacie YAML obejmującą każdy punkt końcowy, jego schematy żądań i odpowiedzi oraz kody błędów, a następnie przekształcisz to w interaktywne dokumenty hostowane z Swagger UI lub Redoc. Oprócz referencji potrzebujemy przewodnika „Jak zacząć”, który przeprowadzi przez autoryzację, limity szybkości, paginację i obsługę błędów, plus przykłady kodu do skopiowania w cURL, PHP i JavaScript dla każdego głównego punktu końcowego. Uzupełnij to kolekcją Postman i szablonem dziennika zmian dla historii wersji.
Zapewnimy dostęp do API, nasze istniejące dokumenty kodu wewnętrznego oraz pełną listę punktów końcowych; oczekujemy gotowej dokumentacji w ciągu dwudziestu jeden dni.
Wyniki:
— 1. Specyfikacja OpenAPI 3.0 w formacie YAML — wszystkie punkty końcowe, schematy żądań/odpowiedzi, kody błędów
— 2. Interaktywna dokumentacja API — strona hostowana w Swagger UI lub Redoc
— 3. Przewodnik „Jak zacząć” — autoryzacja, limity szybkości, paginacja, błędy
— 4. Przykłady kodu — cURL, PHP, JavaScript dla każdego głównego punktu końcowego
— 5. Dziennik zmian — szablon historii wersji
— 6. Eksport kolekcji Postman
Proces:
— Zapewniamy: dostęp do API, istniejące dokumenty kodu, lista punktów końcowych
— Ty dostarczasz: kompletną dokumentację w 21 dni
— Wymagana silna umiejętność pisania technicznego oraz doświadczenie w pracy z API
Szukamy kogoś, kto łączy silne umiejętności pisania technicznego z rzeczywistym doświadczeniem w pracy z API, ponieważ ta praca dotyczy zarówno jasnego wyjaśnienia, jak i dokładnych schematów. Stworzysz pełną specyfikację OpenAPI 3.0 w formacie YAML obejmującą każdy punkt końcowy, jego schematy żądań i odpowiedzi oraz kody błędów, a następnie przekształcisz to w interaktywne dokumenty hostowane z Swagger UI lub Redoc. Oprócz referencji potrzebujemy przewodnika „Jak zacząć”, który przeprowadzi przez autoryzację, limity szybkości, paginację i obsługę błędów, plus przykłady kodu do skopiowania w cURL, PHP i JavaScript dla każdego głównego punktu końcowego. Uzupełnij to kolekcją Postman i szablonem dziennika zmian dla historii wersji.
Zapewnimy dostęp do API, nasze istniejące dokumenty kodu wewnętrznego oraz pełną listę punktów końcowych; oczekujemy gotowej dokumentacji w ciągu dwudziestu jeden dni.
Wyniki:
— 1. Specyfikacja OpenAPI 3.0 w formacie YAML — wszystkie punkty końcowe, schematy żądań/odpowiedzi, kody błędów
— 2. Interaktywna dokumentacja API — strona hostowana w Swagger UI lub Redoc
— 3. Przewodnik „Jak zacząć” — autoryzacja, limity szybkości, paginacja, błędy
— 4. Przykłady kodu — cURL, PHP, JavaScript dla każdego głównego punktu końcowego
— 5. Dziennik zmian — szablon historii wersji
— 6. Eksport kolekcji Postman
Proces:
— Zapewniamy: dostęp do API, istniejące dokumenty kodu, lista punktów końcowych
— Ty dostarczasz: kompletną dokumentację w 21 dni
— Wymagana silna umiejętność pisania technicznego oraz doświadczenie w pracy z API
Teksty i tłumaczenia Gotówka, Przelew bankowy
