Genesis Arbitrage

Genesis Arbitrage · · 3 dk okuma

OpenAPI

OpenAPI (OpenAPI Specification, OAS), bir HTTP API'yi makine tarafından okunabilir biçimde tanımlayan açık standarttır: servisin hangi yollara ve metotlara sahip olduğu, hangi parametreleri aldığı, ne döndürdüğü ve anahtarın nasıl iletileceği. Belge JSON veya YAML ile yazılır; hem insanlar hem programlar kaynak koda erişmeden API'yi bu belgeden anlayabilir.

Standart nereden çıktı

Standart, ilk kez 2011'de yayımlanan Swagger Specification'dan doğdu. 2015'te Swagger 2.0, Linux Foundation'a bağlı açık bir proje olan OpenAPI Initiative'e bağışlandı ve 2016'dan beri spesifikasyon OpenAPI adıyla geliştiriliyor. 3.0 sürümü 2017'de, 3.1 Şubat 2021'de çıktı; en yeni sürüm hattı 3.2'dir (3.1 spesifikasyonu).

Belge neyi tanımlar

Genesis API spesifikasyonundan kısaltılmış bir alıntı: fonlama oranları işlemi ve anahtar şeması:

{
  "openapi": "3.1.0",
  "servers": [{ "url": "https://api.genesisarbitrage.com/v1" }],
  "paths": {
    "/funding/rates": {
      "get": {
        "operationId": "getFundingRates",
        "summary": "Funding rates",
        "x-genesis-plans": ["trial", "start", "pro", "max"],
        "parameters": [
          { "name": "coin", "in": "query", "required": false,
            "schema": { "type": "string" } }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": { "type": "apiKey", "in": "header",
                      "name": "X-API-Key" }
    }
  }
}

x- önekli alanlar spesifikasyon uzantılarıdır: x-genesis-plans, işlemi içeren planları listeler.

Spesifikasyon ne işe yarar

Standart, kullanım alanları arasında dokümantasyon üretmeyi, farklı dillerde istemci ve sunucu üretmeyi ve test etmeyi sayar. Yapay zekâ ajanları için spesifikasyon hazır bir araç setidir: operationId, açıklama ve parametre şeması olan bir işlem, function calling veya bir MCP sunucusu için bir araca dönüşür.

Genesis API'de OpenAPI

Genesis API spesifikasyonu genesisarbitrage.com/openapi.json adresindedir: OpenAPI 3.1, 37 işlem, anahtar X-API-Key başlığında (kimlik doğrulama). Otomatik olarak da bulunabilir: genesisarbitrage.com üzerindeki, RFC 9727 ile tanımlanan /.well-known/api-catalog dosyası ona bir service-desc bağlantısıyla işaret eder. Spesifikasyonu bir ajana nasıl bağlayacağınız yapay zekâ ajanları için Genesis API sayfasında anlatılır.

Ayrıca bakın: REST API, JSON, API endpoint, yapay zekâ ajanları için kripto piyasa verisi.

Sorular ve cevaplar

Swagger ve OpenAPI aynı şey mi?

İki adı olan tek bir standarttır: Swagger Specification 2016'dan beri OpenAPI adıyla geliştirilmektedir. 2.0 sürümü hâlâ Swagger 2.0 olarak yayımlanmıştı; 3.0'dan itibaren OpenAPI Specification olarak yayımlanıyor.

Spesifikasyon varsa SDK'ya ihtiyacım var mı?

Genesis API için hayır: her istek tek başlıklı bir GET'tir, bu yüzden her HTTP istemcisi işe yarar. Tipli metotlar istiyorsanız spesifikasyondan istemci üretmek mantıklıdır.