2014-11-04 14 views
9

Java'da swagger kullanıyorum.Dinamik özel başlıkları swagger olarak gönderme UI denemeleri

Kodda requestAttributes aracılığıyla callerId adında bir başlık okuyorum. Başlığı @HeaderParam ek açıklamasını kullanmıyorum. Bu nedenle, bu nedenle, üst kısım bölümleri, girişler için swagger UI'de görünmüyor.

Bu üstbilgi, deneme formunda nasıl görünebilir.

Başlık değerini kodlamadan bunu başarabileceğim bir yol var mı?

Şimdiden teşekkürler.

cevap

13

@ApiImplicitParams ve @ApiImplicitParam kullanarak bir işlem için parametreler ekleyebilirsiniz.

aşağıdaki wiki belgeleri bu açıklamaları nasıl kullanılacağına dair bir açıklama ile sağlamalıdır - https://github.com/swagger-api/swagger-core/wiki/Annotations#apiimplicitparam-apiimplicitparams

unutmayın bu bir güvenlik başlığı ama API aslında parçası olmadığını burada varsayalım (en azından dayalı verdiğin açıklama). Bir güvenlik başlığı arıyorsanız, alternatif bir yöntem var. Lütfen bir yorum bırakın ve bu yanıtı düzenleyeceğim.

+0

Evet Bir güvenlik başlığı değil bir api üstbilgisi arıyorum. Ben açıklama ekledim ama ben hala bu swagger UI veya onun çağrı geçirilen içinde göremiyorum. Jersey'i kullanıyorum. @ApiImplicitParam (name = "name", value = "example", gerekli = true, dataType = "string", paramType = "query"). Lütfen tavsiye. –

+0

'@ ApiImplicitParam' öğesini' @ ApiImplicitParams' için bir değer olarak kullanmanız gerekir (tekil ve çoğul formları dikkate alın). Ayrıca, paramType'ın "başlık" olduğundan emin olun, aksi takdirde bir sorgu parametresi ekliyorsunuz. – Ron

+1

Çalıştı. Teşekkürler!. @ApiImplicitParams ({@ ApiImplicitParam (name = "callerId", gerekli = true, dataType = "string", paramType = "header")}) –

İlgili konular