C# 为ASP.net WebAPI自动生成文档
我目前在ASP.Net中有一个使用WebApi的MVC项目。控制器的大部分代码都是用c#编写的。我想自动生成API调用的描述,包括: 1.)页面/端点的url 2.)端点/页面功能的描述 3.)带有说明和数据类型的参数列表 4.)HTTP动词(get、post、put、delete) 5.)页面所需的权限 说明必须手动编写 我读过很多其他文章,这些文章导致个人使用第三方应用程序,如Swagger。ASP.Net是否内置了一些功能来帮助您完成此任务?如果我想尝试自己生成文档(不使用第三方软件),我将如何开始创建此类文档 我花了相当多的时间在谷歌上搜索各种各样的问题,似乎找不到答案C# 为ASP.net WebAPI自动生成文档,c#,asp.net,asp.net-mvc,asp.net-web-api,C#,Asp.net,Asp.net Mvc,Asp.net Web Api,我目前在ASP.Net中有一个使用WebApi的MVC项目。控制器的大部分代码都是用c#编写的。我想自动生成API调用的描述,包括: 1.)页面/端点的url 2.)端点/页面功能的描述 3.)带有说明和数据类型的参数列表 4.)HTTP动词(get、post、put、delete) 5.)页面所需的权限 说明必须手动编写 我读过很多其他文章,这些文章导致个人使用第三方应用程序,如Swagger。ASP.Net是否内置了一些功能来帮助您完成此任务?如果我想尝试自己生成文档(不使用第三方软件),我
编辑:在我的案例中,在ASP.Net帮助页面上使用Swagger有什么好处?作为Swagger的替代方法,您可以使用for ASP.Net Web API 本文档中的条目将自动生成,并包含以下信息:
- 相对URI
- HTTP方法
- 请求/响应数据示例
- API用途说明(源自XML注释)
如果可以使用第三方组件,那么我建议您使用(使用)来实现API文档。Swagger不仅仅列出您的API URI。用户实际试用了它们并看到了响应 Swagger有工具在您实现文档之前创建文档
它还可以使用注释添加说明。类似的内容?看起来它可能就是我要找的。我去看看,然后回来。感谢您的快速回复。AzureAPI应用程序甚至使用了Swagger,所以您可能更喜欢它。您可以使用来生成documentation@PanagiotisKanavos在我的例子中,在ASP.Net上使用Swagger有什么好处?如果您的Swagger api使用者类似于SwaggerUI,它将允许用户直接从文档中尝试api调用。使用帮助页面的缺点是它会给您的项目添加大量内容。虚张声势的缺点是。