2015-09-30 17 views
9

Microsoft yığınına aşinayım. Bazı huzurlu hizmetler için OData kullanıyorum. Geçenlerde API belgeleri için Swagger'la karşılaştım ve OData ile nasıl ilişkili olduğunu anlamaya çalışıyorum. Her ikisi de RESTful özellikleri gibi görünüyor. Hangisi yaygın olarak kullanılıyor?Swagger nedir ve OData ile ilgilidir?

cevap

20

Havalıbelgelenmesi API'ler bir özelliğidir. API'nız için havalı bir doküman oluşturarak, belgeyi düzgün, okunabilir bir biçimde işleyen ve API'larınızı çağırmak için bir araç sağlayan Swagger UI örneğine iletebilirsiniz. Daha fazla bilgi için swagger.io web sitesine bakın.

OData

http üzerinde veri hizmetlerini oluşturmak için bir özelliğidir, bir hizmet inşa edilmelidir nasıl ve izlenmesi gerektiği desenleri tanımlar. Örneğin, bir veri kümesinin ilk n sonuçlarını sağlamak için $ top yönergesinin kullanılması. OData şu anda sürüm 4'tür, ancak v2 belgelerinde very good overview vardır. Microsoft için

Swashbuckle is a nuget package

çıkış belgesini şekillendirmeye sağlayan kod ve ek meta teftiş dayalı API en otomatikman için swagger belgeleri ürettiğini yığını. Eğer Swashbuckle otomatik inşa ediyoruz bir OData API için swagger belgeleri oluşturmak istiyorsanız

, o zaman Swashbuckle.OData sizin için bu sağlamak için kullanabilirsiniz.

Umarım bu herhangi bir karışıklığı gidermeye yardımcı olur.