Projekt OpenMRS.org
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
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;
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 2025-07-25 UTC."],[[["The project aims to create user-friendly GitHub documentation for OpenMRS's REST API, making it accessible to both technical and non-technical users."],["It involves developing interactive documentation with \"try-out\" options and clear descriptions of API use cases, enhancing the existing Swagger environment."],["This 3-month Google Season of Docs project will utilize JS, HTML, and CSS to improve the accessibility and understanding of the OpenMRS REST API."]]],["The project aims to improve the OpenMRS.org REST API documentation by creating an interactive environment where users can test APIs. The core objective is to make the documentation more accessible to both technical and non-technical users. This will involve integrating the existing Swagger environment with descriptive documentation, including \"try out\" options. The project will use JS, HTML, and CSS to create a user-friendly interface and enhance the presentation of the API documentation. The project will last three months.\n"]]
