Jak udokumentować API REST?
Jak udokumentować API REST? Nie tylko dokumentacja zasobów, ale tak naprawdę to, jakie dane są wysyłane w żądaniu i jakie dane są przesyłane w odpowiedzi. Nie jest to wystarczająco przydatne, aby wiedzieć, że coś oczekuje na wysłanie XML i zwraca XML; lub JASN; lub cokolwiek. Jak udokumentować dane przesyłane w żądaniu i dane wysłane w odpowiedzi?
Najlepiej jak dotąd udało mi się znaleźć narzędzie Enunciate, w którym można udokumentować swój interfejs REST API i elementy danych. Czy Enunciate jest odpowiednim typem tego narzędzia i czy brakuje mi innych narzędzi, które oferują to, na co powinienem spojrzeć?
Konsumenci mojego interfejsu API REST mogą być w dowolnym pythonie językowym, Javie, .NET itp