To jest aplikacja dla systemu Linux o nazwie apiDoc, której najnowszą wersję można pobrać jako apidoc-1.2.0.zip. Można go uruchomić online w darmowym dostawcy usług hostingowych OnWorks dla stacji roboczych.
Pobierz i uruchom online tę aplikację o nazwie apiDoc z OnWorks za darmo.
Postępuj zgodnie z tymi instrukcjami, aby uruchomić tę aplikację:
- 1. Pobrałem tę aplikację na swój komputer.
- 2. Wpisz w naszym menedżerze plików https://www.onworks.net/myfiles.php?username=XXXXX z wybraną nazwą użytkownika.
- 3. Prześlij tę aplikację w takim menedżerze plików.
- 4. Uruchom emulator online OnWorks Linux lub Windows online lub emulator online MACOS z tej witryny.
- 5. W systemie operacyjnym OnWorks Linux, który właśnie uruchomiłeś, przejdź do naszego menedżera plików https://www.onworks.net/myfiles.php?username=XXXXX z wybraną nazwą użytkownika.
- 6. Pobierz aplikację, zainstaluj ją i uruchom.
ZDJĘCIA EKRANU:
apiDoc
OPIS:
apiDoc tworzy dokumentację z adnotacji API w kodzie źródłowym. apiDoc daje możliwość dołączenia numeru wersji do interfejsu API, dzięki czemu można łatwo śledzić zmiany między wersjami. Tworzy apiDoc wszystkich plików w dir myapp/, używa szablonu z dir mytemplate/ i umieszcza wszystkie dane wyjściowe w dir apidoc/. Bez żadnego parametru apiDoc generuje dokumentację ze wszystkich plików .cs .dart .erl .go .java .js .php .py .rb .ts w bieżącym katalogu (w tym podkatalogach) i zapisuje dane wyjściowe do ./doc/. apiDoc zawiera domyślny szablon, który wykorzystuje kierownice, Bootstrap, RequireJS i jQuery do generowania wygenerowanych api_data.js i api_project.js jako strony html. Domyślnie wygenerowany apiDoc używa złożonego szablonu, który obsługuje wersjonowanie, aby wyświetlić różne wersje Twojego API i porównywanie, aby wyświetlić zmiany między dwiema wersjami Twojego API. Możesz stworzyć własny szablon i korzystać z plików wygenerowanych w apiDoc.
Korzyści
- apiDoc można rozbudować o własne parametry
- Opcjonalny plik apidoc.json w katalogu głównym Twoich projektów zawiera typowe informacje o Twoim projekcie
- Wyłącz automatyczne wykrywanie języka przeglądarki i ustaw konkretną lokalizację
- W swoich projektach apidoc.json możesz dodać nagłówek i stopkę
- Używając dziedziczenia, możesz zdefiniować fragmenty dokumentacji wielokrotnego użytku
- Możesz zachować dokumentację dla wszystkich poprzednich wersji i najnowszej wersji API
Język programowania
JAVASCRIPT
Kategorie
Jest to aplikacja, którą można również pobrać z https://sourceforge.net/projects/apidoc.mirror/. Jest hostowany w OnWorks, aby można go było uruchomić online w najprostszy sposób z jednego z naszych bezpłatnych systemów operacyjnych.