Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info
Spesifikasyon düzenleyiciyi kullanarak kod yazmadan OpenAPI spesifikasyonları oluşturun ve doğrulayın.
Spesifikasyon düzenleyiciye erişme
Aşağıdaki bölümlerde açıklandığı şekilde spesifikasyon düzenleyicide bir OpenAPI spesifikasyonu açın:
- Yeni bir OpenAPI spesifikasyonu oluşturma
- OpenAPI spesifikasyonunu içe aktarma
- Mevcut bir OpenAPI spesifikasyonunu düzenleme
Aşağıdaki resimde, spesifikasyon düzenleyicide açık olan Petstore API'nin spesifikasyonu gösterilmektedir:
Önceki şekilde belirtildiği gibi, özellik düzenleyici şunları yapmanıza olanak tanır:
- Sol bölmede JSON veya YAML biçimini kullanarak API'nizi modellemek için OpenAPI spesifikasyonunuzu oluşturun.
- Otomatik olarak oluşturulan API belgelerini sağ bölmede görüntüleyin.
- Yazarken özelliklerinizi OpenAPI spesifikasyonu standardına göre doğrulayın.
- OpenAPI spesifikasyonunuzu kaydedin veya spesifikasyonu kapatıp düzenlemelerinizi iptal edin.
JSON ve YAML ile ilgili yardıma ihtiyacım var
JSON (JavaScript Nesne Notasyonu), basit veri yapılarını ve ilişkisel dizileri temsil etmek için kullanılan hafif bir veri değişimi biçimidir. Daha fazla bilgi için https://www.json.org adresini ziyaret edin.
YAML (YAML Ain't Markup Language), listeler, ilişkisel diziler ve skalerler gibi veri yapılarıyla eşleştirilebilecek bir söz dizimi sağlayan bir veri serileştirme/temsil standardıdır. Daha fazla bilgi için https://yaml.org adresini ziyaret edin.
Hem JSON hem de YAML, makine tarafından okunabilir ancak insanların da okuması ve anlaması kolaydır. Aşağıdaki resimde, JSON ve YAML kullanılarak yazılmış aynı OpenAPI spesifikasyonundan iki kısa alıntı karşılaştırılmıştır:
Spesifikasyonları doğrulama
Spesifikasyon düzenleyici, OpenAPI spesifikasyonunuzu OpenAPI spesifikasyonu standardına göre doğrular. OpenAPI spesifikasyonunuzda hata varsa siz yazarken spesifikasyon düzenleyici, sağ bölmenin üst kısmında Hata iletişim kutusunu görüntüler ve hataları ve ilişkili satır numaraları hakkında daha fazla bilgi sağlar. Böylece hataları kolayca düzeltebilirsiniz.
Spesifikasyonu kaydetme
OpenAPI spesifikasyonunu kaydetmek için üst gezinme çubuğunda Kaydet'i tıklayın.
Spesifikasyonu ilk kez kaydediyorsanız bir dosya adı girmeniz istenir. Dosya adı belirtmezseniz varsayılan olarak "Başlıksız" olur. Daha sonra yeniden adlandırabilirsiniz.
Spesifikasyonu kapatma
Düzenlemelerinizi kaydetmeden bir OpenAPI spesifikasyonunu kapatmak için üst gezinme çubuğunda İptal'i tıklayın. Spesifikasyon listesine dönersiniz.