Raporty o użyciu interfejsu API

Raport użycia interfejsu API opisuje zestaw odwołań z jednego zestawu pakunków do innego zestawu pakunków. Raport może zostać wygenerowany przy użyciu Zadania Ant użycia interfejsu API. W oknie dialogowym Narzędzia zewnętrzne jest dostępny interfejs użytkownika do konfigurowania i generowania raportu. Aby utworzyć nową konfigurację skanowania użycia, wystarczy dwukrotnie kliknąć typ konfiguracji Raport użycia interfejsu API.

Karta Raport użycia interfejsu API

Karta Raport użycia interfejsu API umożliwia skonfigurowanie analizy.

Poniższy przykład przedstawia konfigurację, która wyodrębnia wszystkie odwołania do pakunków Eclipse w instalacji 3.4.

Karta Raport użycia interfejsu API


Opcja

Opis

Wartość domyślna

Analizuj Ta opcja umożliwia wybranie obiektu do analizowania, którym może być wersja bazowa interfejsu API, definicja celu lub katalog pakunków. Istnieje także możliwość wygenerowania kodu HTML dla istniejącego raportu. Istnieje możliwość wybrania tylko jednej opcji, a wszystkie opcje można skonfigurować. Oznacza to, że można przejść na stronę preferencji wersji bazowych interfejsu API w celu edytowania istniejących wersji bazowych, jeśli wybrano analizowanie wersji bazowej interfejsu API. Wersja bazowa interfejsu API
Analizuj > Wersja bazowa interfejsu API W polu złożonym można wybrać dowolną wersję bazową interfejsu API do analizy. Domyślna wersja bazowa lub wartość pusta
Analizuj > Wersje bazowe... Ta opcja umożliwia dostęp do strony preferencji Wersje bazowe interfejsu API w celu skonfigurowania wersji bazowej do analizy.  
Analizuj > Definicja elementu docelowego W polu złożonym można wybrać dowolną definicję celu do analizy. Definicja aktywnego celu lub wartość pusta
Analizuj > Elementy docelowe Ta opcja umożliwia dostęp do strony preferencji Platforma docelowa w celu skonfigurowania definicji celu do analizy.  
Analizuj > Katalog Ta opcja umożliwia wprowadzenie pełnej ścieżki do katalogu zawierającego pakunki. wartość pusta
Analizuj > Przeglądaj... Ta opcja umożliwia przeglądanie w poszukiwaniu folderu pakunków do analizy.  
Analizuj > Generuj raport HTML dla istniejącego skanowania użycia Ta opcja umożliwia utworzenie raportu dla istniejącego skanu bez konieczności ponownego wykonywania analizy.  
Szukaj > Odwołania do Ta opcja umożliwia określenie nazwy (lub zgodnego wyrażenia regularnego) pakunku, do którego odwołania mają zostać wyświetlone. Jako przykład można rozważyć następujące wyrażenie: org\.eclipse.*. Ten przykład określa, że mają być wyświetlone wszystkie odwołania do każdego pakunku, którego nazwa rozpoczyna się od nazwy org.eclipse.. wartość pusta
Szukaj > Odwołania do interfejsu API Ta opcja umożliwia skanowanie w poszukiwaniu odwołań do interfejsu API. unchecked
Szukaj > Odwołania wewnętrzne Ta opcja umożliwia skanowanie w poszukiwaniu odwołań wewnętrznych. zaznaczona
Szukaj > Niedozwolone użycie interfejsu API Ta opcja umożliwia skanowanie w poszukiwaniu niedozwolonych użyć interfejsu API, np. użycia zastrzeżonych składowych interfejsu API. unchecked
Szukaj > Zgodne pakunki Ta opcja umożliwia określenie nazwy (lub zgodnego wyrażenia regularnego) pakunków, które maja być skanowane w poszukiwaniu odwołań prowadzących z tych pakunków, tzn. zasięgu wyszukiwania. Jako przykład można rozważyć następujące wyrażenie: .*. Ten przykład określa, że mają być przeszukiwanie wszystkie pakunki, których nazwa jest zgodna z dowolną sekwencją znaków. Ten sam efekt można osiągnąć, pozostawiając pole puste. wartość pusta
Raportowanie > Typ raportu Umożliwia wybranie jednego z dwóch formatów raportu HTML. W przypadku wybrania opcji Raport dotyczący pakunków przywołanych (Producentów) w raporcie będą wymienione wszystkie pakunki zawierające typy, do których istnieją odwołania w przeszukanych pakunkach. W przypadku wybrania opcji Raport dotyczący pakunków przywołujących (Konsumentów) raporty będą uporządkowane tak, aby wyświetlać wszystkie pakunki z zasięgu wyszukiwania, które zawierają odwołania.

Przełączając typy raportów, należy sprawdzić, czy wartości wyrażeń regularnych Odwołania do i Zgodne pakunki są poprawne. W przypadku użycia w danym ustawieniu wyrażenia wieloznacznego, na przykład .*, przełączanie do innego typu raportu często wymaga przeniesienia znaku wieloznacznego do innego ustawienia, aby zapewnić maksymalną użyteczność raportu.

Raport dotyczący pakunków przywołanych (Producentów)
Raportowanie > Położenie wyjściowe raportów Ta opcja umożliwia określenie pełnej ścieżki dla wszystkich generowanych raportów. wartość pusta
Raportowanie > Przeglądaj... Ta opcja umożliwia wybranie położenia wyjściowego dla wszystkich raportów.  
Raportowanie > Wyczyść katalog raportu przed zaraportowaniem nowych wyników Ta opcja umożliwia wyczyszczenie istniejącego położenia raportów XML przed zaraportowaniem dowolnych wyników skanowania. Należy zauważyć, że ta opcja całkowicie usuwa określony katalog raportów, jeśli on istnieje, przy czym są także rekurencyjnie usuwane wszystkie katalogi potomne. unchecked
Raportowanie > Utwórz raporty HTML Ta opcja umożliwia przekształcenie wszystkich danych wyjściowych XML w sformatowany kod HTML i umieszczenie go w katalogu <położenie_raportów>\html. unchecked
Raportowanie > Wyczyść położenie raportów HTML Ta opcja umożliwia wyczyszczenie istniejącego położenia raportów HTML przed utworzeniem nowych raportów. Należy zauważyć, że ta opcja całkowicie usuwa określony katalog plików HTML, jeśli on istnieje, przy czym są także rekurencyjnie usuwane wszystkie katalogi potomne. Ta opcja jest dostępna tylko wtedy, gdy wybrano opcję Utwórz raporty HTML opisaną powyżej. unchecked
Raportowanie > Otwórz raport po zakończeniu wyszukiwania Ta opcja umożliwia otwarcie raportu HTML po zakończeniu analizy. Ta opcja jest dostępna tylko wtedy, gdy wybrano opcję Utwórz raporty HTML opisaną powyżej. unchecked
Raportowanie > Opis Ta opcja umożliwia wprowadzenie czytelnego dla użytkownika opisu raportu. wartość pusta

Karta Wzorce

Karta Wzorce umożliwia tworzenie różnych wzorców wyrażeń regularnych w celu sterowania analizą użycia. Aktualnie są obsługiwane trzy rodzaje wzorców:

  1. Wzorzec archiwum - umożliwia określenie zagnieżdżonych archiwów, które mają być ignorowane podczas analizy.
  2. Wzorzec pakietu - umożliwia określenie pakietów, które powinny być pakietami interfejsu API lub wewnętrznymi, bez konieczności aktualizowania manifestu pakunku.
  3. Wzorzec konwersji raportu - umożliwia utworzenie wyrażenia regularnego nazwy pakietu w celu filtrowania raportowanych odwołań. Wszystkie raportowane odwołania są filtrowane przy użyciu ich pełnych nazw pakietów.

Karta Wzorce


Opcja

Opis

Wartość domyślna

Dodaj Ta opcja umożliwia dodanie nowego wzorca. Ten przycisk uruchamia kreator wzorców.  
Edytuj Ta opcja umożliwia edytowanie aktualnie wybranego wzorca. W danym momencie można edytować tylko jeden wzorzec.  
Usuń Ta opcja umożliwia usunięcie wybranych wzorców. Jednocześnie można usunąć wiele wzorców.  

Czynności pokrewne

Porównywanie z wersją bazową interfejsu API
Konfigurowanie wersji bazowej

Informacje pokrewne

Preferencje wersji bazowych interfejsu API
Kreator wzorców użycia interfejsu API