Soru İyi belgelenmiş RESTful servis örneği [kapalı]


Bir RESTful hizmetinin belgelerini yazmam gerek. Kendi kendime bir şablon olarak kullanabileceğim bir RESTful hizmeti için çok iyi yazılmış bir belgeyi bilen var mı?

Teşekkürler.


64
2018-02-08 19:28


Menşei


Birini buldun mu? Hangisini yaparsan duymak isterim. - Ralf de Kleine
RESTful bir hizmetin çok iyi yazılı belgelere ihtiyacı yoktur. :) - Pedro Werneck
Her bir API iyi yazılmış dokümanlara ihtiyaç duyar - kralco626
Moderatörler çarpıyor. Başka bir yararlı konu, Batı'daki tozu ısırdı. - bbsimonbb
bocoup.com/blog/documenting-your-api - Sampath


Cevaplar:


lütfen kontrol ediniz REST API Dokümantasyon En İyi Uygulamaları RESTful hizmetinizi belgelemek için belgeler. Belge tüm yönleri kapsamaktadır. İşte bir pasajı.

Başlık : Tüm Kullanıcıları Göster.
URL:  / users veya / users /: id veya / users? id =: id
Yöntem :  GET | POST | SİL | KOYMAK
URL Paramları:  Required: kimlik = [tamsayı] VEYA Optional: photo_id = [alfanümerik]
Veri Paramları: {u: {email: [string], name: [string], current_password: [alfanumeric] şifre: [alfanumerik], password_confirmation: [alfanumeric]}}
Yanıt Kodları: Başarı (200 OK), Kötü İstek (400), Yetkisiz (401)


48
2017-09-07 14:06



"string" ve "alfanumeric" veri türleri arasındaki fark nedir? - mre
alfanümerik semboller ve özel karakterler içermez. Dize herhangi bir şey olabilir, alfanümerik [a-zA-Z0-9] gibi görünüyor. - Andrew T Finnell
API'dan ne iade edilir? - Michael Puckett II


Hakkında duydun mu http://swagger.io/ ? Bir REST API'si için çok kullanışlı (ve güzel) bir dokümantasyon oluşturur.

Bir şans ver. Gerçekten tavsiye ederim.


13
2017-07-23 22:30





Referans edebilirsiniz Zoho Abonelik API'sı  Belgeler. Bu 3 sütun düzeni belgesi, kaynaklar tarafından yapılandırılmıştır ve her son nokta için örnek istek ve yanıtı vardır.

Açıklama: Zoho Abonelik ekibinin bir parçasıyım.


12
2017-10-28 07:10



Böyle bir şeyi nasıl yazabilirim? Bunun için herhangi bir araç kullandın mı? Lütfen bana öner, API dokümantasyonumuzu oluşturmak için yoldayım. - theGamblerRises


Twitter Api belgeleri karşılaştığım en iyisi.


5
2018-02-08 19:32



Twitter'a bağlantı API dokümanları değişti - https://dev.twitter.com/rest/public - GuirNab


CouchDB API'sı, "" RESTful veritabanı.

Belgenin, metottan ziyade kaynak ile yapılandırıldığını ve çok iyi bilinen API belgelerinin çoğundan daha fazla kaynak odaklı olduğunu fark edeceksiniz.


3
2018-01-16 06:43





Deneyin dinlenme-aracı.

Yazım şartnamesi için bir dil agnostik yaklaşımı izler. Raftan RESTful API'leri için anında sahte uygulama ve otomatik birim testi sağlar.

Hizmetler YAML dosyaları ile belirtilir ve örnek veriler tanımlayıcıların hemen yanına yerleştirilebilir. Service.yml tanımlayıcı dosyasının formatını içeren bir JSON şemasını bulabilirsiniz. Bu bir guilde olarak kullanılabilir, ancak talep üzerine uzatılabilir.


1
2018-03-01 10:32





Okunabilirlik API'sı son zamanlarda Twitter'da övüldü.

Açıklama: Ben Okunabilirliğin yaratıcısı Arc90'da ve bir Okunabilirlik yatırımcısıyım.


0
2018-02-08 21:00



Bağlantıyı ziyaret edip şunu elde ederim: Okunabilirlik artık mevcut değil - yu yang Jian