OpenAPI · AsyncAPI · Protobuf · GraphQL

Jeden zestaw narzędzi do każdego kontraktu API

API Genie lintuje i formatuje opisy API, wychwytuje zmiany łamiące zgodność, zanim trafią na produkcję, mockuje i testuje kontraktowo działające API, generuje klientów, serwery i dokumentację dla stosu, którego już używasz, oraz edytuje pliki w formularzach bez utraty jednego bajtu. Z wiersza poleceń, przeglądarki, pulpitu lub VS Code, ręcznie albo przez agenta AI.

brew install mykulyak/apigenie/apigenie
Terminal z uruchomionym apigenie diff: każda zmiana między dwiema wersjami API Petstore, oceniona jako łamiąca lub niełamiąca zgodności

apigenie diff ocenia każdą zmianę między dwiema wersjami API i zatrzymuje build na tych łamiących zgodność.

Generuje kod w językach

  • TypeScript
  • Python
  • C#
  • Java
  • Go
  • Elixir

Od pierwszego lintu do opublikowanej dokumentacji

Nie składaj lintera, narzędzia do diffów i kilku generatorów kodu z osobnych kawałków. API Genie obejmuje cały proces.

  • Lintuj i formatuj

    Sprawdzaj każdy opis API według swoich reguł i trzymaj go w jednym stylu

  • Wychwytuj zmiany łamiące zgodność

    Wiedz, co każda zmiana zrobi Twoim klientom, zanim trafi na produkcję

  • Generuj kod

    Klienci, serwery, schematy i dane testowe w sześciu językach

  • Mockuj i testuj

    Mockuj API na podstawie kontraktów i sprawdzaj prawdziwe względem nich

  • Publikuj dokumentację API

    Witryny z dokumentacją albo komponenty webowe z dokumentacją na Twoich stronach

  • Edytuj w formularzach

    Edytuj OpenAPI i AsyncAPI w formularzach i zachowaj swoje pliki

  • Kataloguj swoje API

    Znaj każde API w repozytorium i wiedz, kto jest jego właścicielem

  • Pracuj z agentami AI

    Sprawdzenia, diffy i raporty czytelne maszynowo dla agentów, które piszą Twoje API

  • Działa z Twoimi standardami API

    OpenAPI od 3.0 do 3.2, Swagger 2.0, AsyncAPI, Protobuf i GraphQL

Komponenty dokumentacji

Dokumentacja API na Twoich własnych stronach

Twój portal ma już swój układ, nawigację i przewodniki. Wstaw <apg-api-reference> na jedną z jego stron, a czytelnicy przejrzą tam operacje i wyślą żądania. Elementy działają w zwykłym HTML-u, CMS-ie, React, Vue, Svelte i Angularze.

Strona Twojej witryny, z Twoją nawigacją i akapitami, oraz elementy apg-operation, apg-schema i apg-auth umieszczone między nimiyour-site.example/docs/ordersTwoja stronaPrzewodniki · Cennik · API<apg-operation operation-id="getPet">żądanie, odpowiedzi i Try it out<apg-schema name="Pet">pola, z przykładem<apg-auth schemes="ApiKey">jeden klucz dla każdego Try it out na stronie
Szare linie to Twój tekst; niebieskie ramki to elementy, które czytają jeden dokument i dzielą jego serwer i dane uwierzytelniające.

Zacznij od jednego pliku i jednego polecenia

Zainstaluj CLI i zlintuj opis API, który już masz. Diff, serwer mocków, generatory i dokumentacja czytają ten sam plik, kiedy ich potrzebujesz.

Maskotka API Genie trzymająca kafelki OpenAPI, AsyncAPI, Protobuf i GraphQL