'daki veri ek açıklamaları ASP.NET ve Swagger kullanarak bir POST kabul eden karmaşık bir tür açığa çıkarıyorum. Farklı kısıtlı uzunluklara sahip bir dizi dize alanı vardır. Bunu Swagger UI'de nasıl yansıtabilirim?Swagger
Q
Swagger
9
A
cevap
12
System.ComponentModel.DataAnnotations
'dan StringLengthAttribute
ile ilgili özelliklere açıklama ekleyebilirsiniz. Örneğin
:
"name": {
"minLength": 0,
"maxLength": 10,
"type": "string"
}
Ve bu:
[StringLength(10)]
public String Name {get;set;}
olacak
[StringLength(10, MinimumLength = 5)]
public String Name {get;set;}
olur:
"name": {
"minLength": 5,
"maxLength": 10,
"type": "string"
}
StringLength
Swashbuckle ayrıca Range
ve RegularExpression
özniteliklerini de destekler.
Güncelleme
MaxLength
çalışmaz. StringLength
yapar. Ancak, bu bilgiyi Swagger UI'de keşfetmek biraz beceriksizdir.
İlgili konular
- 1. Swagger editörü Swagger editörü
- 2. Swagger
- 3. Swagger
- 4. Swagger + javadoc oluşturma araçları (swagger-jaxrs-doclet, swagger-core), OSGI ortamında çalışmaz
- 5. swagger-node-express: Dosya, swagger-ui'den nasıl yüklenir?
- 6. Java Swagger Annotation Swagger json şemasına nasıl dönüştürülür?
- 7. Swagger belgeleri nasıl paylaşılır
- 8. JSDoc'tan Swagger YAML Oluşturma?
- 9. Swagger ui url parametresi
- 10. Swagger HashMap özellik türü
- 11. django-rest-swagger: docstring
- 12. Swagger-codegen'i kullanmaya başla
- 13. Swagger UI ServiceStack
- 14. Karmaşık json modelini swagger
- 15. Swagger İstek URL'si sorunu
- 16. Swagger ve Tarih
- 17. ServiceStack Swagger DTO Hariç tutmuyor
- 18. Swagger modelleri bölümünü nasıl kullanırım?
- 19. Swagger Müşteri API anahtarı doğrulaması
- 20. Üretimde swagger-ui'yi nasıl kapatıyorsunuz
- 21. Swagger UI hatası: API Listeleme alınamadı
- 22. Swagger 2.0 metin açıklamaları nasıl biçimlendirilir?
- 23. Değişim swagger 2.0 docs yol url
- 24. swagger ve jboss ile javax doğrulama
- 25. django-rest-swagger: uç noktaları nasıl gruplanır?
- 26. Swagger: haritası <dize, Nesne>
- 27. Sorgu Dizesi Param'ları Benim Swagger Özellikleri'ne Ekleme
- 28. Swagger gövdesini ve formData parametresini gönder
- 29. Üzüm Swagger UI - Yakalamayan TypeError: Boş '
- 30. Swagger doc, swashbuckle kullanarak üretmeyi durdurdu
Teşekkür: Eğer nesnenin
Model
gidin ve ardından mülkiyet üzerinde gezdirin gerekiyor. MaxLength özniteliğini kullanıyordum. Ama ne "maxLength" görüntüler: Swagger UI'de 10 bölüm. – illugKatılıyorum biraz hantal. Bu ek açıklamalardan daha fazlasına sahip olduğunuzda, hover bit'i gerçekten işe yaramaz. Birbirlerinin üstüne yığılacaklar ve hangi alandan söz ettiklerini bilmiyorsunuz. Yine de müthiş bir cevap için teşekkürler. – illug
En son sürüm "Swashbuckle" sürümünün sürümü, yığılmış kutuları düzelten yeni bir Swagger UI sürümü içerir. – venerik