Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Spec Editor'ı 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 spesifikasyonu içe aktarma
- Mevcut bir OpenAPI spesifikasyonunu düzenleme
Aşağıdaki şekilde, spesifikasyon düzenleyicide açık olan Petstore API'nin spesifikasyonu gösterilmektedir:
Önceki şekilde vurgulandığı gibi, spesifikasyon 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 dokümanlarını sağ bölmede görüntüleyin.
- Yazarken spesifikasyonunuzu 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ım
JSON (JavaScript Object Notation), 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 adresini ziyaret edin.
YAML (YAML Ain't Markup Language), listeler, ilişkisel diziler ve skalerler gibi veri yapılarıyla eşlenebilen bir söz dizimi sağlayan 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 tarafından da kolayca okunup anlaşılabilir. Aşağıdaki şekilde, JSON ve YAML kullanılarak yazılmış aynı OpenAPI spesifikasyonundan iki kısa alıntı karşılaştırılmaktadır:
Bir spesifikasyonu doğrulama
Spesifikasyon düzenleyici, OpenAPI Spesifikasyonunuzu OpenAPI Spesifikasyonu standardına göre doğrular. Yazarken OpenAPI Spesifikasyonunuzda hatalar varsa spesifikasyon düzenleyici, sağ bölmenin üst kısmında Hata iletişim kutusunu gösterir. Ayrıca, hatalar ve bunlarla ilişkili satır numaraları hakkında daha fazla bilgi vererek hataları kolayca düzeltmenizi sağlar.
Şartname kaydetme
OpenAPI Spesifikasyonu'nu kaydetmek için üst gezinme çubuğunda Kaydet'i tıklayın.
Spesifikasyonu ilk kez kaydediyorsanız dosya adı girmeniz istenir. Dosya adı belirtmezseniz varsayılan olarak Untitled (Başlıksız) kullanılır. Daha sonra yeniden adlandırabilirsiniz.
Bir spesifikasyonu kapatma
Düzenlemelerinizi kaydetmeden bir OpenAPI Spesifikasyonu'nu kapatmak için üst gezinme çubuğunda İptal'i tıklayın. Şartname listesine yönlendirilirsiniz.