Katalog

Znajdź specyfikacje API i zapisz ich właścicieli

apigenie-catalog znajduje specyfikacje API w repozytorium Git. Trzymaj ich nazwy i właścicieli obok kodu, bez hostowania usługi katalogu.Eksperymentalne: poza obietnicą zgodności 1.0, więc polecenia i wyjście mogą się jeszcze zmienić.

Wypisz swoje API Czytaj dokumentację

Żadnej usługi katalogu do utrzymaniaSpecyfikacje i własność zostają w Twoim repozytorium. Nie ma serwera do uruchomienia ani niczego do wgrania.
Inwentarz przed jakąkolwiek konfiguracjąapigenie-catalog list znajduje specyfikacje OpenAPI, AsyncAPI, Swagger, Protobuf i GraphQL wśród plików śledzonych przez Git, bez konfiguracji.
Właściciel zmienia się w commicieNazwy i właściciele są zapisani w apigenie.yaml. Zmiana właściciela to commit, który recenzuje Twój zespół.

Od plików śledzonych przez Git do właścicieli w CI

list czyta repozytorium tak, jak widzi je Git, init zapisuje nazwy i właścicieli, których przechowujesz, a wyjście JSON przekazuje jedno i drugie skryptom.

Bez usługi i bez wgrywania: repozytorium jest katalogiem, a zmiana właściciela to commit.

Co `list` znajduje bez konfiguracji

W repozytorium Git katalog patrzy na pliki śledzone przez Git, więc wyniki builda i pliki ignorowane zostają poza nim. Każdy wiersz mówi, czym jest specyfikacja, w jakiej jest wersji, gdzie leży i kiedy ostatnio się zmieniła.

$ apigenie-catalog list
NAME             FORMAT           VERSION  PATH                      COMMIT
order-events     AsyncAPI 3.0.0   2.0.0    apis/events.json          96175d8 2026-10-12
orders-api       OpenAPI 3.1.0    1.2.0    apis/orders/openapi.yaml  4d0c2e1 2026-10-14
acme-pricing-v1  Protobuf proto3  -        proto/pricing.proto       96175d8 2026-10-12

Potem nadaj im nazwy i właścicieli

apigenie-catalog init zapisuje po jednym wpisie na specyfikację do uzupełnienia. Uruchom ponownie po dodaniu specyfikacji: nowe są dodawane, Twoje zmiany zostają, a wpisy plików, których już nie ma, są zgłaszane.

catalog:
  specs:
    - name: orders-api
      path: apis/orders/openapi.yaml
      owner: team-commerce

Czytaj właścicieli ze swoich skryptów

apigenie-catalog list --json zawiera zapisane nazwy i właścicieli obok formatu i ścieżki każdej specyfikacji. Ten fragment wpisu z tablicy specs raportu pokazuje, co może odczytać dashboard lub zadanie CI.

{
  "name": "orders-api",
  "format": "openapi",
  "path": "apis/orders/openapi.yaml",
  "owner": "team-commerce",
  "listed": true
}

Użyj inwentarza w code review i w CI

Inwentarz do reviewZobacz każde API w repozytorium z jego formatem, wersją i ostatnim commitem, w tabeli lub jako JSON.
Własność w code reviewWłaściciele mieszkają obok kodu, więc zmiana właściciela to commit, recenzowany jak każdy inny.
Wejście dla Twoich narzędziWyjście JSON ma opublikowany schemat, dla skryptów, dashboardów i zadań CI, które pracują na każdym API w repozytorium.

Instalacja

Pakiety CLI zawierają apigenie-catalog. Obecnie inwentaryzuje jedno repozytorium naraz. Katalogi obejmujące wiele repozytoriów, tagi wydań i przypięci konsumenci są w planach; polecenia i wyjście pozostają eksperymentalne.

Zastosowania

Kataloguj swoje API