Muszę napisać dokumentację usługi RESTful. Czy ktoś wie o bardzo dobrze napisanej dokumentacji dotyczącej usługi RESTful, którą mogę wykorzystać jako szablon dla siebie?Przykład dobrze udokumentowanej usługi RESTful
Dzięki.
Najlepszym z dostępnych jest Twitter Api documentation.
Link do dokumentów API Twittera zmieniono - [https://dev.twitter.com/rest/public](https://dev.twitter.com/ rest/public) – GuirNab
The Readability API został ostatnio wyróżniony na Twitterze.
Ujawnienie: Jestem Parterem w Arc90, twórcami Czytelnictwa i inwestorem w Czytelność.
The API of CouchDB, "the" baza danych RESTful.
Zauważysz, że dokument jest uporządkowany według zasobów, a nie według metody, dzięki czemu jest bardziej zorientowany na zasoby niż większość znanych dokumentacji API.
Wypróbuj rest-tool.
Stosuje się podejście agnostyczne do pisania w języku. Zapewnia natychmiastową symulację wdrożenia i automatyczne testowanie jednostkowe dla RESTful API z półki.
Usługi są określane za pomocą plików YAML, a przykładowe dane mogą znajdować się tuż obok deskryptorów. Schemat JSON można znaleźć w formacie deskryptora service.yml. Może to być wykorzystane jako gildia, ale można ją rozszerzyć na żądanie.
Możesz odwołać się do dokumentacji Zoho Subscriptions API. Ten dokument złożony z 3 kolumn jest uporządkowany według zasobów i ma przykładowe żądanie i odpowiedź dla każdego punktu końcowego.
Ujawnienie: Jestem częścią zespołu Zoho Subscriptions.
Jak mogę napisać coś takiego? Czy używałeś do tego jakiegokolwiek narzędzia? Proszę mnie zasugerować, jestem na dobrej drodze do zbudowania naszej dokumentacji API. – theGamblerRises
Czy słyszałeś o http://swagger.io/? Generuje bardzo przydatną (i ładną) dokumentację dla REST API.
Spróbuj. Naprawdę to polecam.
Proszę sprawdzić dokumentację REST API Documentation Best Practices w celu udokumentowania usługi REST. Dokument obejmuje wszystkie aspekty. Oto fragment tego.
Tytuł: Pokaż wszystkich użytkowników.
URL:/użytkowników lub/Users /: id lub/użytkowników id =: id
Metoda: GET | POST | USUŃ | PUT
URL Params:Required:id = [liczba całkowita] lubOptional:photo_id = [alfanumeryczny]
danych Params: {U {e: [ciąg] Nazwa: [ciąg] current_password [alfanumeryczny] hasło [alfanumeryczny] password_confirmation: [alfanumeryczny]}}
kody odpowiedzi: Sukces (200 OK), Bad Request (400), niedozwolonym (401)
jaka jest różnica między typami danych "ciąg" i "alfanumeryczny"? – mre
Znalazłeś jeden? Chciałbym usłyszeć, który z nich zrobiłeś. –
Usługa RESTful nie wymaga bardzo dobrze napisanej dokumentacji. :) –
Każde API potrzebuje dobrze napisanej dokumentacji – kralco626