Veri API'si oluşturucusunda OpenAPI

OpenAPI belirtimi, HTTP API'lerini belgelemede dil açısından bağımsız bir standarttır. Veri API'si oluşturucusu OpenAPI'i şu şekilde destekler:

• Çalışma zamanı yapılandırmasında tanımlanan tüm REST özellikli varlıklar için meta veriler oluşturma
• Bu meta verileri geçerli bir OpenAPI şemasına derleme
• Şemayı görsel kullanıcı arabirimi (Swagger) aracılığıyla veya serileştirilmiş JSON dosyası olarak ortaya çıkarma

OpenAPI açıklama belgesi

Veri API'si oluşturucusu, rest özellikli her varlık için çalışma zamanı yapılandırmasını ve veritabanı meta verilerini kullanarak bir OpenAPI açıklama belgesi oluşturur.

Şema , OpenAPI.NET SDK kullanılarak oluşturulur ve OpenAPI Belirtimi v3.0.1'e uygundur. Bir JSON belgesi olarak üretilir.

OpenAPI belgesine şu konumdan erişebilirsiniz:

GET /{rest-path}/openapi

[! NOT] Varsayılan olarak , rest-path şeklindedir api. Bu değer yapılandırılabilir. Ayrıntılar için bkz. REST yapılandırması .

Swagger Kullanıcı Arabirimi

Swagger kullanıcı arabirimi , OpenAPI şemasına göre API'nin etkileşimli, web tabanlı bir görünümünü sağlar.

Development modunda, Veri API oluşturucu Swagger kullanıcı arabirimini şu konumda kullanıma sunar:

GET /swagger

Bu uç nokta, kullanıcı tanımlı varlıklarla çakışmaları önlemek için rest-path öğesinin altına yerleştirilmemiştir.