Làm cách nào để tạo tài liệu API cho SignalR

Có cách nào để thực hiện việc này không?Làm cách nào để tạo tài liệu API cho SignalR

Tôi có swashbuckle tạo nội dung cho các API khác của tôi nhưng tôi không tin rằng nó hoạt động cho SignalR.

2015-03-09 LivingOnACloud

Tôi rất quan tâm đến điều tương tự ở đây, mặc dù tôi ngày càng ấn tượng rằng SignalR chủ yếu là giao tiếp nội bộ, tức là; giữa các bên thứ nhất. Kết hợp điều này với bản chất năng động của việc gọi SignalR, tôi không nghĩ là một công cụ vững chắc như Swashbuckle sẽ có sẵn. Tôi sẽ thử nghiệm với một thư viện mà tôi thấy rằng tạo ra các giao diện TypeScript, nhưng chưa thiết lập một quy trình làm việc nào. –

Ngoài ra, nếu bạn muốn hiển thị API "thời gian thực" công khai, có thể lược đồ gọi lại sẽ phù hợp hơn. Một cái gì đó như [Facebook] (https://developers.facebook.com/docs/graph-api/real-time-updates/v2.3) hoặc [Github] (https://developer.github.com/webhooks/) , nhưng điều này không thực sự giúp ích cho các dự án trang web đơn giản. –

Tôi đã không thể tìm thấy bất kỳ công cụ nào để tạo tài liệu cho Swagger cho SignalR, mặc dù tôi rất muốn một người nào đó chỉ cho tôi thứ gì đó mà tôi đã bỏ lỡ. Tôi ngạc nhiên câu hỏi này đã không có ngay cả một nỗ lực tại một câu trả lời. – Nathan

Giả sử bạn đang sử dụng Asp.NET Core, tài liệu tùy chỉnh có thể được tiêm vào lúc khởi động.

Trong bạn Startup.ConfigureServices bạn nên đã có một phần Swagger:

services.AddSwaggerGen(c => 
{ 
    ... 
})

Chỉ cần thêm một file XML tùy chỉnh để tài liệu Swagger:

services.AddSwaggerGen(c => 
{ 
    c.IncludeXmlComments("custom_doc.xml"); 
})

nơi custom_doc.xml là một C# tập tin tài liệu XML tiêu chuẩn.

Nguồn

2018-02-09 14:22:07

Làm cách nào để tạo tài liệu API cho SignalR

Trả lời

Các vấn đề liên quan