Aracılığıyla paylaş

Swagger / OpenAPI ile Veri API'si oluşturucu REST API belgeleri

  • Makale

OpenAPI belirtimi, HTTP API'lerini belgeleme için programlama dilinden bağımsız bir standarttır. Veri API'si oluşturucusu, OpenAPI standardını aşağıdaki özellikleriyle destekler:

  • REST özellikli tüm çalışma zamanı yapılandırması tanımlı varlıklar hakkında bilgi oluşturun.
  • Bilgileri OpenAPI şemasıyla eşleşen bir biçimde derleyin.
  • Oluşturulan OpenAPI şemasını görsel kullanıcı arabirimi (Swagger) veya serileştirilmiş bir dosya aracılığıyla kullanıma sunar.

OpenAPI açıklama belgesi

Veri API'si oluşturucusu, tanımlanan her REST özellikli varlık için sağlanan çalışma zamanı yapılandırmasını ve veritabanı nesnesi meta verilerini kullanarak bir OpenAPI açıklama belgesi oluşturur. Şema dosyası, OpenAPI.NET SDK tarafından sağlanan işlevler kullanılarak oluşturulur. Şu anda şema dosyası, JSON olarak biçimlendirilmiş OpenAPI Belirtimi v3.0.1'e bağlı olarak oluşturulur.

OpenAPI açıklama belgesi, Veri API'si oluşturucusundan şu yoldan getirilebilir:

GET /{rest-path}/openapi

Not

Varsayılan olarak, rest-path değer api yapılandırılabilir ve şeklindedir. Daha fazla bilgi için bkz . REST yapılandırması

SwaggerUI

Swagger UI , oluşturulan OpenAPI belirtimini kullanarak hizmet hakkında bilgi sağlayan web tabanlı bir kullanıcı arabirimi sunar.

Modunda Development , Veri API'si oluşturucusu ayrılmış bir uç noktadan oluşturulan OpenAPI açıklama belgesini görüntülemeyi etkinleştirir:

GET /swagger

Çalışma zamanı yapılandırılmış varlıklarla adlandırma çakışmalarını önlemek için "Swagger" uç noktası altında rest-path iç içe yerleştirılmaz.

İlgili içerik