ServiceStack Кураж - Марк метод как «New» или «обновление»

Question

я, вероятно, сбили пламя для спрашивать это:

Хочу отметить конечные точки в моей API, как «New» или «Обновлено «поэтому, когда разработчики просматривают мой пользовательский интерфейс swagger, они могут видеть все последние дополнения.

Существует ли такая вещь?

Answer 1

Это не существует в основной функции Swagger-UI или поддержке Swagger ServiceStack.

Но вы можете катиться самостоятельно без особых усилий. Фокус в том, что свойства Summary и NotesRouteAttribute поддерживают исходный HTML.

Украсьте DTO как это:

static class Docs { 
    public const string NewApi = @"<em class=""new-api"">New!</em> "; 
} 

[Route(...., Notes = Docs.NewApi + "Detailed description of DTO goes here")] 
public class MyDto { ... } 

// OR 

[Route(...., Summary = Docs.NewApi + "Summary goes here")] 
public class MyDto { ... } 

Затем вы можете добавить некоторые CSS к вашему чванство-Ui index.html:

.new-api { 
    background-color: #ffff00; 
    font-weight: bold; 
    font-style: normal; 
} 

Теперь вы можете просто добавить эту строку константу в Notes или Summary, в соответствующих атрибутах Route, и он будет отображаться как стильный маркер в пользовательском интерфейсе Swagger. Конечно, вам нужно будет вручную добавлять/удалять эти маркеры, когда вы вносите изменения в свои DTO, но это довольно просто реализовать.