API dokümantasyonuTeknik Dokümantasyon

Uç nokta açıklamalarınızdan API dokümantasyonu

Genellikle 15 dakika içinde hazırRevizyonlar dahilKalite kontrolü
Paketler
Ödeme korumasıAyrıntılar
  • Paket kapsamındaki revizyonlar ücretsizdir.
  • Teslimattan sonraki 3 gün içinde yanıt vermezseniz iş otomatik olarak onaylanır.

Para, ödeme yaptığınızda bloke edilir ve yalnızca işi onayladığınızda aktarılır.

Uç nokta açıklamalarınızdan API dokümantasyonu

Örnek sonuç

Standart paket için örnek

SOP set: opening and closing procedures for a small café

SOP-02: Closing the café

PurposeLeave the café clean, safe and ready for the morning shift
WhoThe closing barista; the shift lead signs off
WhenStart at 5:30 pm, doors locked at 6:00 pm, finished by 6:45 pm
You needClosing checklist sheet, till key, cleaning caddy, blue cloths

Before you start

Warning: Never switch off the main power at the wall. The fridges and the alarm run on the same board.

Steps

  1. At 5:30 pm, turn the door sign to "Last orders". Customers already inside can stay until 6:00.
  2. Switch the coffee machine to rinse mode. Press and hold the cup button for 5 seconds. You should see: "RINSE" flashing on the display and hot water running through both group heads for about 2 minutes.
  3. Take out the portafilters and soak them in the black container with one cleaning tablet. Leave them for 20 minutes.
  4. Move cakes and sandwiches to the back fridge. Label anything opened today with today's date and "Use by tomorrow".
  5. Record the fridge temperatures on the log sheet. You should see: between 1 °C and 5 °C. If a fridge shows above 5 °C, go to step 12 first.
  6. At 6:00 pm, lock the front door and turn the sign to "Closed".
  7. Close the till. Press MENU, then "End of day", then "Z report". You should see: the report printing with today's total. Do not count the cash at the counter; take the drawer to the office.

(Steps 8–14: floors, bins, alarm and handover note.)

If something goes wrong

ProblemWhat to do
Fridge above 5 °CMove food to the second fridge, note the time and temperature, message the shift lead
Z report does not printReplace the paper roll; if it still fails, write the total from the screen and photograph it
Alarm will not setCheck the back door is fully shut; the alarm will not arm with it open

Sign-off

Closing barista: name, time. Shift lead: initials.

Last reviewed: [date]. Review again when the coffee machine or till is replaced.

Client: Bluebell Café, 22 seats, 7 staff working in rotating shifts Input: the owner's voice notes, a handwritten checklist and 9 photos of the counter, coffee machine and till screen Delivered: a set of 6 SOPs (4,600 words): opening, closing, cash handling, fridge temperature log, deep-cleaning the coffee machine, handling a customer complaint. Below: an excerpt of the closing procedure.

Müşteri ve tüm ayrıntılar kurgusaldır.

Bu hizmet hakkında

Geliştiriciler bir API'yi dakikalar içinde dokümantasyonuna bakarak değerlendirir: kimlik doğrulama veya ilk istek çalışmazsa giderler. Uç nokta açıklamalarınızdan, OpenAPI dosyanızdan veya kod örneklerinizden API referansı ve rehberler yazıyoruz: kimlik doğrulama, temel URL'ler, parametreleri olan her uç nokta, istek ve yanıt örnekleri, hata kodları, istek sınırları ve sayfalama. Hızlı başlangıç, ilk başarılı çağrıyı birkaç adımda gösterir.

Neler dahil

  • Neler alırsınızReadMe, GitBook, Docusaurus veya deponuza hazır, kod bloklu Markdown olarak API dokümantasyonu. Gönderdiklerinizden yazarız, API'nize kendimiz çağrı yapmayız.
  • Hızlı başlangıçAPI anahtarından ilk çağrıya
  • Uç nokta referansıParametreler, türler, örnekler
  • Hatalar ve sınırlarKodlar, anlamları, yeniden deneme önerisi
  • Kod örneklericURL ve seçeceğiniz bir dil
  • Tutarlı terimlerŞemanızdaki adlarla aynı

Nasıl çalışır

  1. 1
    BrifUç noktaları ve örnekleri yapıştırır veya eklersiniz
  2. 2
    Yapı ve yazımReferansı ve rehberleri yazarız
  3. 3
    TeslimatYayına hazır Markdown alırsınız

Sizden neler gerekiyor

Metin olarak yapıştırılmış uç nokta açıklamaları veya bir OpenAPI ya da Postman dosyası, kimlik doğrulama ayrıntıları, örnek istekler ve yanıtlar, hata kodları ve API kullanıcılarınızın kim olduğu.

Size soracaklarımız:

  • API ne yapıyor ve kimler kullanıyor?
  • Kimlik doğrulama nasıl çalışıyor?
  • cURL dışında kod örnekleri hangi dilde olsun?
  • Dokümanlar nerede yayımlanacak?

Paketleri karşılaştırın

PaketlerTemelHızlı başlangıç ve 5 uç noktaya kadar$19StandartRehberli 20 uç noktaya kadar$39Premium50 uç noktaya kadar tam dokümantasyon$79
Teslim süresi1 gün3 gün5 gün
Revizyonlar123
Uzunluken fazla 2.000 kelimeen fazla 6.000 kelimeen fazla 14.000 kelime
Uç noktalaren fazla 5en fazla 20en fazla 50
Kod örneği dillericURLcURL + 1cURL + 2
Sipariş ver TemelSipariş ver StandartSipariş ver Premium

Ödeme koruması

Sipariş verirken ödersiniz, ancak para yalnızca onaylanan iş için aktarılır.

  • Sabit fiyatPaket fiyatı, ödeme yaptıktan sonra değişmez.
  • Para bloke edilirÖdeme yaptığınızda tutar yalnızca bloke edilir. İşi onayladığınızda hizmete aktarılır.
  • Teslimattan önce kontrolHer sonuç size ulaşmadan önce kalite kontrolünden geçer ve onaylamadan önce sipariş sayfasında görürsünüz.
  • Ücretsiz revizyonlarBrifiniz kapsamında, paketin izin verdiği sayıda değişiklik isteyin.
  • 3 gün sonra onayTeslimattan sonraki 3 gün içinde işi onaylamaz veya değişiklik istemezseniz iş otomatik olarak onaylanır. Teslimattan sonra sipariş sohbetine yazarsanız sipariş bekletilir; yanıt verdikten sonra 3 günlük süreyi yeniden başlatabiliriz ve bunu sohbette bildiririz.
  • Yeniden yapım veya tam iadeSonuç brifinize uymuyorsa ve revizyonlar sorunu çözmediyse ya da iş teslim süresinin iki katından uzun sürerse sipariş sohbetine yazın: işi yeniden yaparız veya ödemenin tamamını iade ederiz.
Nasıl çalışır →

Sorular ve yanıtlar

OpenAPI belirtimimizden çalışabilir misiniz?

Evet, YAML veya JSON'u brife yapıştırın. Açıklamalarını okunabilir referans sayfalarına dönüştürür, belirttiğiniz boşlukları dolduruz.

Örnekleri test ediyor musunuz?

API'nize çağrı yapmayız. Örnekler istek ve yanıt örneklerinizden oluşturulur; yayımlamadan önce bir kez çalıştırın.

SDK dokümanları yazıyor musunuz?

Evet, metot imzalarını ve kullanım örneklerini gönderirseniz. Her SDK'yı paket hacminin bir parçası sayın.

Yanıtınızı bulamadınız mı?

Paketler