Automatycznie generowana dokumentacja
GraphQL Editor automatycznie generuje prostą dokumentację dla twojej schemy. Uzupełnij ją używając markdown w naszym łatwym w obsłudze interfejsie.
01Generowane programowo
GraphQL Editor automatycznie generuje podstawową dokumentację dla każdej schemy, wystarczy tylko uzupełnić opisy i pełna dokumentacja jest gotowa.
02Łatwość przeglądania
Stwórz dokumentację za pomocą naszego przyjaznego dla użytkownika interfejsu. Wystarczy kliknąć na typ z listy, aby przewinąć do niego w kodzie schemy, kliknąć na typ w kodzie, aby przejść do jego dokumentacji lub po prostu skorzystać z paska wyszukiwania na górze.
03Pełna obsługa markdown
Za pomocą markdown można dodawać do dokumentacji nagłówki, linki, tabele lub bloki kodu. Pełna dowolność w stylizowaniu docsów, aby były bardziej czytelne i atrakcyjne.
Tutorial wideo
Przekonaj się jak łatwe jest tworzenie dokumentacji markdown dla swojego projektu w GraphQl Editor.
Dokumentacja GraphQL API
Pisanie dokumentacji jest trochę kłopotliwe i większość programistów nie lubi tego robić, więc na pewno docenią narzędzie, które oferuje w tym dużą pomoc. GraphQL Editor automatycznie generuje podstawową dokumentację, stąd już tylko wpisywanie opisów. Duży schemat bez dokumentacji będzie dużym problemem i będzie oznaczać tonę pracy w dół linii. Zamiast tego wypełnij go na bieżąco, korzystając z naszych intuicyjnych narzędzi nawigacyjnych i stylizuj go za pomocą markdown. Dobra dokumentacja GraphQL API to najprostsza droga do przyciągnięcia użytkowników.
Dokumentacja Markdown
Przeczytaj o tej funkcji w naszej dokumentacji