Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- OpenMRS.org
- Pisarz techniczny:
- Ayeshmantha
- Nazwa projektu:
- Tworzenie przyjaznej dla użytkownika dokumentacji GithHub interfejsu API REST
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Głównym celem projektu jest opracowanie interaktywnej dokumentacji, w której użytkownicy mogą wchodzić w interakcje z interfejsami API, korzystając z opcji testowania. Tymczasem mamy bardziej opisowy i wyjaśniony samodzielnie opis, który wyjaśnia osobom technicznym i nietechnicznym sytuacje, w których należy użyć punktu końcowego.
Obecne środowisko sztuczne jest świetne, ale entuzjastom techniki i innych obeznanych technologicznie trudniej jest opracować pomysł bezpośrednio bez odpowiedniej dokumentacji. Głównym pomysłem jest zebranie środowiska swagger i dokumentacji w jednym miejscu w przyjemnej formie. za pomocą JavaScriptu, HTML i CSS;