Dokumentacja APIDokumentacja techniczna

Dokumentacja API na podstawie opisów twoich endpointów

Realizacja od 1 dniaPoprawki w cenieKontrola jakości
Pakiety
Ochrona płatnościSzczegóły
  • Poprawki w ramach pakietu są bezpłatne.
  • Jeśli nie odpowiesz w ciągu 3 dni od dostarczenia pracy, zostanie ona zaakceptowana automatycznie.
Zamów · 35 €

Pieniądze są rezerwowane w chwili płatności i przekazywane dopiero po akceptacji pracy.

Dokumentacja API na podstawie opisów twoich endpointów

Przykładowy rezultat

Przykład dla pakietu Standard

Zestaw procedur: otwarcie i zamknięcie małej kawiarni

PR-02: Zamknięcie kawiarni

CelZostawić kawiarnię czystą, bezpieczną i gotową na poranną zmianę
KtoBarista zamykający; kierownik zmiany zatwierdza
KiedyStart o 17:30, drzwi zamknięte o 18:00, koniec do 18:45
PotrzebneLista kontrolna zamknięcia, kluczyk do kasy, koszyk ze środkami czystości, niebieskie ściereczki

Zanim zaczniesz

Uwaga: nigdy nie wyłączaj głównego zasilania. Lodówki i alarm są na tej samej rozdzielni.

Kroki

  1. O 17:30 odwróć tabliczkę na drzwiach na "Ostatnie zamówienia". Goście, którzy już są w środku, mogą zostać do 18:00.
  2. Przełącz ekspres w tryb płukania. Przytrzymaj przycisk filiżanki przez 5 sekund. Powinieneś zobaczyć: migający napis "RINSE" i gorącą wodę płynącą z obu grup przez ok. 2 minuty.
  3. Wyjmij kolby i namocz je w czarnym pojemniku z jedną tabletką czyszczącą. Zostaw na 20 minut.
  4. Przenieś ciasta i kanapki do lodówki na zapleczu. Wszystko otwarte dzisiaj oznacz dzisiejszą datą i "Zużyć do jutra".
  5. Zapisz temperatury lodówek w rejestrze. Powinieneś zobaczyć: od 1 °C do 5 °C. Jeśli lodówka pokazuje powyżej 5 °C, najpierw przejdź do kroku 12.
  6. O 18:00 zamknij drzwi wejściowe i odwróć tabliczkę na "Zamknięte".
  7. Zamknij kasę. Naciśnij MENU, potem "Koniec dnia", potem "Raport dobowy". Powinieneś zobaczyć: wydruk raportu z dzisiejszym utargiem. Nie licz gotówki przy ladzie; zanieś szufladę do biura.

(Kroki 8–14: podłogi, śmieci, alarm i notatka dla kolejnej zmiany.)

Jeśli coś pójdzie nie tak

ProblemCo zrobić
Lodówka powyżej 5 °CPrzenieś jedzenie do drugiej lodówki, zapisz godzinę i temperaturę, napisz do kierownika zmiany
Raport dobowy się nie drukujeWymień rolkę papieru; jeśli dalej nie działa, zapisz utarg z ekranu i zrób zdjęcie
Alarm nie chce się uzbroićSprawdź, czy tylne drzwi są domknięte; przy otwartych alarm się nie włączy

Zatwierdzenie

Barista zamykający: imię i nazwisko, godzina. Kierownik zmiany: parafka.

Ostatni przegląd: [data]. Przejrzeć ponownie przy wymianie ekspresu lub kasy.

Klient: Kawiarnia Dzwonek, 22 miejsca, 7 pracowników na zmianach rotacyjnych Materiał: notatki głosowe właścicielki, odręczna lista kontrolna i 9 zdjęć lady, ekspresu i ekranu kasy Dostarczono: zestaw 6 procedur (4600 słów): otwarcie, zamknięcie, obsługa gotówki, rejestr temperatur lodówek, gruntowne czyszczenie ekspresu, obsługa reklamacji. Poniżej fragment procedury zamknięcia.

Klient i wszystkie dane są wymyślone.

O usłudze

Programiści oceniają API po dokumentacji w ciągu kilku minut: jeśli uwierzytelnianie lub pierwsze zapytanie nie działa, odchodzą. Piszemy dokumentację referencyjną API i poradniki na podstawie opisów endpointów, pliku OpenAPI lub przykładów kodu: uwierzytelnianie, bazowe adresy URL, każdy endpoint z parametrami, przykłady zapytań i odpowiedzi, kody błędów, limity zapytań i paginacja. Szybki start pokazuje pierwsze udane wywołanie w kilku krokach.

Co obejmuje usługa

  • Co otrzymujeszDokumentacja API w Markdownie z blokami kodu, gotowa dla ReadMe, GitBook, Docusaurus lub twojego repozytorium. Piszemy na podstawie przesłanych materiałów i sami nie wywołujemy twojego API.
  • Szybki startOd klucza API do pierwszego wywołania
  • Dokumentacja endpointówParametry, typy, przykłady
  • Błędy i limityKody, znaczenia, wskazówki dotyczące ponowień
  • Przykłady koducURL plus jeden wybrany język
  • Spójne nazewnictwoTe same nazwy co w twoim schemacie

Jak to działa

  1. 1
    BriefTy wklejasz lub załączasz endpointy i przykłady
  2. 2
    Struktura i pisaniePiszemy dokumentację referencyjną i poradniki
  3. 3
    DostarczenieOtrzymujesz Markdown gotowy do publikacji

Czego potrzebujemy od Ciebie

Opisy endpointów lub plik OpenAPI albo Postman wklejony jako tekst, szczegóły uwierzytelniania, przykładowe zapytania i odpowiedzi, kody błędów oraz informację, kim są użytkownicy twojego API.

Zapytamy Cię:

  • Co robi API i kto z niego korzysta?
  • Jak działa uwierzytelnianie?
  • W jakim języku oprócz cURL mają być przykłady kodu?
  • Gdzie zostanie opublikowana dokumentacja?

Porównaj pakiety

PakietyPodstawowySzybki start i do 5 endpointów17 €StandardDo 20 endpointów z poradnikami35 €PremiumDo 50 endpointów, pełna dokumentacja70 €
Termin1 dzień3 dni5 dni
Poprawki123
Długośćdo 2000 słówdo 6000 słówdo 14 000 słów
Endpointydo 5do 20do 50
Języki przykładów koducURLcURL + 1cURL + 2
Zamów PodstawowyZamów StandardZamów Premium

Ochrona płatności

Płacisz przy składaniu zamówienia, ale pieniądze są przekazywane tylko za zaakceptowaną pracę.

  • Stała cenaCena pakietu nie zmienia się po zapłacie.
  • Pieniądze są zarezerwowanePrzy płatności kwota jest tylko rezerwowana. Serwis otrzymuje ją dopiero po akceptacji pracy.
  • Sprawdzone przed dostarczeniemKażdy wynik przechodzi kontrolę jakości, zanim do Ciebie trafi, a przed akceptacją widzisz go na stronie zamówienia.
  • Bezpłatne poprawkiProś o poprawki w ramach briefu tyle razy, ile przewiduje pakiet.
  • Akceptacja po 3 dniachJeśli w ciągu 3 dni od dostarczenia pracy ani jej nie zaakceptujesz, ani nie poprosisz o poprawki, zostanie zaakceptowana automatycznie. Jeśli po dostarczeniu napiszesz na czacie zamówienia, zamówienie czeka; po naszej odpowiedzi możemy ponownie uruchomić odliczanie 3 dni i poinformujemy o tym na czacie.
  • Ponowne wykonanie lub pełny zwrot pieniędzyJeśli wynik nie odpowiada Twojemu briefowi, a poprawki tego nie naprawiły, lub praca trwa ponad dwa razy dłużej niż termin, napisz na czacie zamówienia: wykonamy pracę ponownie albo zwrócimy całą płatność.
Jak to działa →

Pytania i odpowiedzi

Czy możecie pracować na podstawie naszej specyfikacji OpenAPI?

Tak, wklej YAML lub JSON do briefu. Zamienimy jej opisy w czytelne strony referencyjne i uzupełnimy wskazane przez ciebie luki.

Czy przetestujecie przykłady?

Nie wywołujemy twojego API. Przykłady powstają z twoich próbek zapytań i odpowiedzi, więc uruchom je raz przed publikacją.

Czy piszecie dokumentację SDK?

Tak, jeśli prześlesz sygnatury metod i przykłady użycia. Każde SDK wlicza się do objętości pakietu.

Pakiety
Zamów · 35 €· 3 dni