Web Api

Posted 最爱吃汤圆27

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Web Api相关的知识,希望对你有一定的参考价值。

这篇想写一个工具。Nswag,这个工具能够让接口数据可视化,也可以生产API文档,同时可以生成客户端代码,进行测试。

不过我目前在学习阶段,觉得该工具好用的地方是接口可视化,非常的直观和明了,其他的功能我还没有用到。

我参考了网上的工具安装方法,自己也尝试了一下。

本次使用的是VS2019+ASP.NET CORE 3.0

1.安装nuget包NSwag.AspNetCore (创建项目的过程就直接跳过了)

 

 

 PS:如果有小伙伴搜Nuget搜不出来,请查看Nuget设置。如下图,可以根据箭头所示加号自己添加一个程序包源,名称和源安装如下所示。

 

2.接下来,在Startup.cs文件中配置Nswag服务和中间件。

 

 

 在Configure中加入中间件。

 

 

 3.配置项目 用于生成XML文件 我现在还没怎么用到 现在当做记录一下

 

 

 4.改配置文件,将launchBrowser 改成/swagger

 

 

 5.启动项目看下效果. 默认打开的网址是:http://localhost:5000/swagger/index.html

这个可视化的接口工具看的非常清楚,一目了然。

以上是关于Web Api的主要内容,如果未能解决你的问题,请参考以下文章

Azure Active Directory:web api调用另一个web api

从我的Web API调用第三方Web API时,Web服务器挂起

RESTful API 与 Web 服务 API

从另一个 Web api 调用 Web api

[Web API] Web API 2 深入系列 特性路由

Asp.Net Web API 2第五课——Web API路由