失眠网,内容丰富有趣,生活中的好帮手!
失眠网 > oracle web API 在Web API程序中使用Swagger做接口文档

oracle web API 在Web API程序中使用Swagger做接口文档

时间:2019-03-06 04:46:20

相关推荐

oracle web API 在Web API程序中使用Swagger做接口文档

#### 创建Web API程序

在VS中创建一个 Web应用程序,选择Web API来创建RESTful的HTTP服务项目,构选MVC和Web API核心引用。

#### 安装Swashbuckle

使用NuGet包管理器,查找安装Swashbuckle,也就是Swagger插件。

#### 配置SwaggerConfig

在APP_START里找到SwaggerConfig,大概在105行左右有对c.IncludeXmlComments的注释,在此处添加配置:

```C#

c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

```

在SwaggerConfig的最后,给类添加方法:

```C#

protected static string GetXmlCommentsPath(string name)

{

return string.Format(@"{0}\bin\{1}.xml", System.AppDomain.CurrentDomain.BaseDirectory, name);

}

```

#### 维护接口方法的Summary

维护好controller路径中各个控制器接口方法的summary注释。

#### 生成项目的XML文档文件

在API项目的生成设置里,构选生成XML文档文件。

#### 编译并运行程序

编译、运行程序,在打开的Web地址后加上swagger,可以看到自动生成的接口文档和summary信息,可对接口进行测试。

![swagger](http://img./blog//12/08/9c8251c5ed233526.png?x-oss-process=style/bb "swagger")

来自 “ ITPUB博客 ” ,链接:/28974745/viewspace-2667442/,如需转载,请注明出处,否则将追究法律责任。

如果觉得《oracle web API 在Web API程序中使用Swagger做接口文档》对你有帮助,请点赞、收藏,并留下你的观点哦!

本内容不代表本网观点和政治立场,如有侵犯你的权益请联系我们处理。
网友评论
网友评论仅供其表达个人看法,并不表明网站立场。