Kataloguj swoje API

Każde API w repozytorium i jego właściciel

Potrzebujesz definicji API i właściciela, którego można zapytać. Jedno polecenie wypisuje specyfikacje śledzone przez Git, ich ostatnie zmiany i właścicieli, których zapisałeś.Eksperymentalne: poza obietnicą zgodności 1.0, więc polecenia i wyjście mogą się jeszcze zmienić.

Wypisz swoje API Zainstaluj API Genie

Inwentarz bez konfiguracjiapigenie-catalog list znajduje śledzone przez Git pliki OpenAPI, AsyncAPI, Swagger 2.0, Protobuf i GraphQL w repozytorium, bez żadnej konfiguracji.
Właściciele w code reviewNazwy i właściciele mieszkają w apigenie.yaml, więc zmiana właściciela to zrecenzowany commit.
Nic do hostowaniaRepozytorium jest katalogiem: bez serwera, bez wgrywania, a historia API to historia repozytorium.

Inwentarz i właściciele, których dodajesz

init zapisuje wpis na każdą specyfikację śledzoną przez Git, z owner: null do uzupełnienia. list wypisuje potem tabelę z właścicielami albo JSON z opublikowanym schematem.

$ apigenie-catalog init
$ cat apigenie.yaml
catalog:
  specs:
    - name: order-events
      path: apis/events.json
      owner: null
    - name: orders-api
      path: apis/orders.yaml
      owner: null
$ # fill in the owners, commit, and
$ apigenie-catalog list
NAME          FORMAT          VERSION  OWNER          PATH              COMMIT
order-events  AsyncAPI 3.0.0  2.0.0    team-events    apis/events.json  96175d8 2026-10-12
orders-api    OpenAPI 3.1.0   1.2.0    team-commerce  apis/orders.yaml  4d0c2e1 2026-10-14

Co obejmuje

listKażda specyfikacja z jej formatem, wersją, ścieżką i ostatnim commitem.
initNazwy i właściciele w pliku konfiguracyjnym, zachowane przy kolejnych uruchomieniach.
Wyjście JSONRaport z opublikowanym schematem, dla skryptów i dashboardów.

Narzędzie, które to robi

Katalog

Krok po kroku (przewodnik po angielsku)

Catalog the APIs of a repository: List every API specification of a repository, give each a stable name and an owner, and keep the catalog current in CI.

Uruchom w repozytorium, które masz

apigenie-catalog list znajduje specyfikacje bez konfiguracji. init dodaje nazwy i właścicieli, gdy ich chcesz, w pliku, który recenzujesz jak kod.