Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Spesifikasyon düzenleyicisini kullanarak herhangi bir kod yazmadan OpenAPI Specifications oluşturun ve doğrulayın.
Teknik özellik düzenleyiciye erişme
Aşağıdaki bölümlerde açıklandığı şekilde spesifikasyon düzenleyicide bir OpenAPI Spesifikasyonu açın:
- Yeni bir OpenAPI Belirtimi oluşturma
- OpenAPI Spesifikasyonunu İçe Aktarma
- Mevcut bir OpenAPI Spesifikasyonunu düzenleme
Aşağıdaki şekilde, spesifikasyon düzenleyicide açık olan Petstore API spesifikasyonu gösterilmektedir:
Önceki şekilde gösterildiği gibi, spesifikasyon düzenleyici sayesinde şunları yapabilirsiniz:
- Sol bölmede JSON veya YAML biçimini kullanarak API'nizin modelini oluşturmak için OpenAPI Spesifikasyonunuzu oluşturun.
- Otomatik olarak oluşturulan API belgelerini sağ bölmede görüntüleyin.
- Yazarken OpenAPI Spesifikasyonu standardına göre spesifikinizi doğrulayın.
- OpenAPI Spesifikasyonunuzu kaydedin veya spesifikasyonu kapatıp düzenlemelerinizi iptal edin.
JSON ve YAML konusunda yardım et
JSON (JavaScript Object Notation - JavaScript Nesne Gösterimi), basit veri yapılarını ve ilişkisel dizileri temsil etmek için kullanılan hafif bir veri değişim biçimidir. Daha fazla bilgi için https://www.json.org adresine bakın.
YAML (YAML Ayıklama Dili), listeler, ilişkisel diziler ve skalerler gibi veri yapılarıyla eşleştirilebilen söz dizimini sağlayan bir veri serileştirme/temsil standardıdır. Daha fazla bilgi için https://yaml.org adresine bakın.
Hem JSON hem de YAML makine tarafından okunabilse de insanlar tarafından da kolayca okunup anlaşılabilir. Aşağıdaki şekilde, JSON ve YAML kullanılarak yazılmış aynı OpenAPI Specification'dan iki kısa alıntı karşılaştırılmaktadır:
Bir spesifikasyonu doğrulama
Spesifikasyon düzenleyici, OpenAPI Spesifikasyonunuzu OpenAPI Specification standardına göre doğrular. Siz yazarken, OpenAPI Spesifikasyonunuzda hatalar varsa spesifikasyon düzenleyici, sağ bölmenin üst kısmında Hata iletişim kutusunu görüntüler ve kolayca düzeltebilmeniz için hatalar ve ilişkili satır numaraları hakkında daha fazla bilgi sağlar.
Spesifikasyonu kaydetme
OpenAPI Spesifikasyonunu kaydetmek için üst gezinme çubuğunda Kaydet'i tıklayın.
Belirtimi ilk kez kaydediyorsanız bir dosya adı girmeniz istenir. Dosya adı belirtmezseniz varsayılan olarak Adsız olur. Alanı daha sonra yeniden adlandırabilirsiniz.
Spesifikasyonu kapat
Düzenlemelerinizi kaydetmeden OpenAPI Spesifikasyonu'nu kapatmak için üst gezinme çubuğunda İptal'i tıklayın. Spesifikasyon listesine döndürülürsünüz.