如何在 .NET Core Web API 中的 Swagger UI 上指定示例？
[英]How to specify example on Swagger UI in .NET Core Web API?
問題描述
我想在 swagger 上指定一個字符串輸入格式的示例，以供用戶參考。
我想做的是在屬性 ColumnAndSortOrder 下方放置一個示例，例如“例如資源，Asc”
是否可以在 .NET Core 中這樣做？
順便說一句，我正在使用 swagger UI 3.0
歡迎任何幫助或指點。
1 個解決方案
解決方案1
1 2022-07-24 12:01:17
您可以使用這兩個屬性：
[System.ComponentModel.Description("some description")]
或者
[Swashbuckle.AspNetCore.Annotations("some description")]
在您的 api 或屬性上
ASP.NET Core Web API - 如何在 Swagger 文檔中指定必填字段
[英]ASP.NET Core Web API - How to specify required fields in Swagger Documentation
Swagger - 如何顯示更復雜的響應示例 - ASP.net 核心 Web ZDB974238714CA8DE634A7CE1DFZ3
[英]Swagger - how to show a more complex response example - ASP.net Core Web API
如何在 .NET 核心 Web api 中將上傳按鈕添加到招搖 UI？
[英]How can I add an upload button to swagger UI in .NET core web api?
如何在 .Net Core Web API 的 swagger 中設置基本路徑屬性
[英]How to set base path property in swagger for .Net Core Web API
如何在 Swagger for .Net Core Web Api 中覆蓋描述“無參數”？
[英]How to override description 'No parameters' in Swagger for .Net Core Web Api?
ASP.NET Core Web API 6: Swagger example XML POST body
[英]ASP.NET Core Web API 6: Swagger example XML POST body
使用 ASP.NET Core 6 Swagger UI 時出錯 Web API 自定義路由
[英]Getting error for Swagger UI with an ASP.NET Core 6 Web API with custom routing
聲明:本站的技術帖子網頁，遵循CC BY-SA 4.0協議，如果您需要轉載，請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.
相關問題
Swagger UI 響應示例 Asp.Net Core Web Api
ASP.NET Core Web API - 如何在 Swagger 文檔中指定必填字段
Swagger - 如何顯示更復雜的響應示例 - ASP.net 核心 Web ZDB974238714CA8DE634A7CE1DFZ3
Cutomize Swagger UI ASP.NET核心Web API
如何在 .NET 核心 Web api 中將上傳按鈕添加到招搖 UI？
如何在 .Net Core Web API 的 swagger 中設置基本路徑屬性
如何在 Swagger for .Net Core Web Api 中覆蓋描述“無參數”？
ASP.NET Core Web API 6: Swagger example XML POST body
使用 ASP.NET Core 6 Swagger UI 時出錯 Web API 自定義路由
Swagger 不工作 Asp.net 內核如何打開 swagger ui
相關標簽