自定义自动生成的Swagger定义
安乙
我使用了swagger设置，以便在启动时使用NSwag基于WebApi中的控制器生成开放的Api规范和Swagger Ui。我想增强招摇的Ui包括
- 每个端点的摘要/说明
- 需要它们的端点的示例参数输入
- POST调用的示例请求正文
- 一个访问令牌示例，只能在swagger文档中使用，以轻松地进行身份验证并可以尝试所有操作（类似于此示例https://petstore.swagger.io/）
我是NSwag的新手，不确定如何将这些增强功能添加到我的代码中，例如在何处添加它们，我需要使用什么（控制器上的注释？XML注释？另一种方式？）。 Swagger Editor”，但由于每次启动应用程序时都会重新生成此代码，因此不知道如何使用。
我已经阅读了NSwag文档，但这似乎与添加已经配置的ASP.NET Core中间件有关。
编辑：我现在在页面顶部有一个描述，并且已经能够在XML注释中添加带有remarks标签的示例-有比使用XML注释更优雅的方法吗？
安乙
现在解决了这个问题，最终使用操作处理器来配置Swagger UI / OpenApi端点摘要，请求示例，路径参数示例值和可能的UI响应代码
网上没有很多文档可以做到这一点（我所能找到的只是XML注释的实现方式，所以要花很多时间才能使它起作用）
在这里将我的解决方案发布给其他不希望使用XML注释使控制器混乱的人。
将OpenApiOperationProcessor属性应用于控制器操作
创建操作处理器并编写SwaggerUI自定义代码
可以这样填写路径参数的示例值
本文收集自互联网，转载请注明来源。
如有侵权，请联系[email protected] 删除。
编辑于
相关文章
Related 相关文章
- 1
SQL Server中的自定义自动生成的列
- 2
Buildroot自定义软件包不会自动生成
- 3
自动生成自定义格式的注册码
- 4
自动生成自定义C库的头文件
- 5
自动生成时 WPF DataGrid 自定义标题宽度
- 6
自定义SwaggerDocument生成
- 7
Swagger-Codegen自定义设置
- 8
Swagger自定义标签删除Python
- 9
Swagger-Codegen自定义设置
- 10
自定义 Django Swagger 框架
- 11
向其生成的swagger API添加自定义包丘路线
- 12
我如何告诉swagger-codgen我的自定义生成器？
- 13
如何使用swagger代码生成带有自定义Datetime注释的模型
- 14
Swagger-Tools中的Swagger-UI自定义
- 15
自定义从UITextView打开的自动MFMailComposeViewController
- 16
自定义自动完成的角材料
- 17
CodeMirror自动完成自定义列表
- 18
在angularjs中自定义自动完成
- 19
自定义自动R降价报告
- 20
自动使自定义异常抛出
- 21
自动启动jQuery自定义队列
- 22
Excel，自定义自动填充功能
- 23
jQuery自定义自动完成
- 24
自定义tableviewcell和自动布局
- 25
自动完成的jQuery与自定义数据
- 26
自定义jQuery警报自动关闭
- 27
Xamarin 表单 - 自定义自动完成
- 28
Sublime Text 自定义自动完成
- 29
Java：生成自定义元素集
我来说两句