2013-01-24 64 views
6

Có thể với ServiceStack.Api.Swagger v3.9.33 để mô tả phản hồi của hoạt động API và mã trạng thái trả về sử dụng Swagger không? Có lẽ bởi trang trí thuộc tính trên lớp Response/tài sản vvCách chỉ định Lớp phản hồi và trả lại Mã trạng thái sử dụng Swagger/ServiceStack

Giống như các phần tô đậm cho sự vận hành ví dụ sau đây từ các cửa hàng vật nuôi API: (http://petstore.swagger.wordnik.com/)

enter image description here

Tôi chỉ có thể xem Các phương thức HTTP và Yêu cầu DTOS có thể được trang trí trên https://github.com/ServiceStack/ServiceStack/wiki/Swagger-API và xem nhanh mã có vẻ như chưa được hỗ trợ, https://github.com/ServiceStack/ServiceStack/tree/master/src/ServiceStack.Api.Swagger

Trả lời

3

Hiện tại, có thể nếu bạn kéo người đứng đầu của repo ServiceStack. Tôi vừa nhận được yêu cầu kéo hợp nhất thêm tùy chọn để trang trí DTO yêu cầu của bạn với thuộc tính [ApiResponse]. Xem ở đây để biết chi tiết:

https://github.com/ServiceStack/ServiceStack/issues/590#issuecomment-17575292

+0

Thật không may vấn đề đã biến mất: (tôi có ApiResponse thuộc tính nhưng chỉ để thêm StatusCodes Khi tôi kiểm tra json Model ResponseClass có nhưng không có thuộc tính mặc dù tôi có nó Api & ApiMember – unreal

1

Tôi hiện đang tìm kiếm giải pháp cho cùng một vấn đề.

Tôi đã đến khám phá này, mà nó hiện đang không được thực hiện -> xem: https://github.com/ServiceStack/ServiceStack/blob/master/src/ServiceStack.Api.Swagger/SwaggerApiService.cs cho bằng chứng

Vì vậy, hiện nay có không tích hợp của mô hình phản ứng hoặc Codes Trạng thái.

+0

Vâng, tôi cho rằng không có phản hồi trong một vài tháng có nghĩa là không có tiến bộ nào, hy vọng trên lộ trình. Chúc mừng. –

+0

Nếu bạn có một số giờ rảnh rỗi, tôi đã xem xét ngắn gọn: mẫu: http://petstore.swagger.wordnik.com/api/api-docs.json/pet tài liệu: https://github.com/ wordnik/swagger-core/wiki/Resource-Listing Tôi sẽ đề xuất: đi qua tất cả các lớp phản hồi (giống như cách dịch vụ ngăn xếp với yêu cầu) và quét Thuộc tính (bạn sẽ phải chỉ định chúng) -> nhưng phần đó là rất nhiều cho C# /. net kiến ​​thức của tôi –

+0

vé github tương ứng: https://github.com/ServiceStack/ServiceStack/issues/590 –

2

Cố gắng làm cho yêu cầu của bạn (nơi bạn đã áp dụng RouteAttribute) để thực hiện ServiceStack.ServiceHost.IReturn<TResponseType> nơi TResponseType là kiểu trả lời của bạn.

Vì vậy, ví dụ nên giống như thế:

[Route("/todos")] 
[Route("/todos/{Ids}")] 
public class Todos : IReturn<List<Todo>> 

IReturn<List<Todo>> là những gì bạn đang tìm kiếm

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