.net webapi导出html,C#(.Net Core WebAPI)之API文档的生成(Swagger)
标签:一 : 安装Swagger
搜Swashbuckle.AspNetCore
在NuGet 中,安装 Swashbuckle.AspNetCore :
我使用的版本为 : 5.0.0-rc2
二 : 引入Swagger功能
Ⅰ : Startup.cs
① ,ConfigureServices方法中:
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2).AddJsonOptions(options =>
{
options.SerializerSettings.Formatting = Formatting.Indented;
});
services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1", new OpenApiInfo()
{
Title = "Swagger Test UI",
Version = "v1",
Description = "Aonaufly first ASP.NET Core Web API"
});
options.CustomSchemaIds(type => type.FullName); // 解决相同类名会报错的问题
options.IncludeXmlComments(Path.Combine(Directory.GetCurrentDirectory(), "WebAPIPoco.xml")); // 标注要使用的 XML 文档
options.DescribeAllEnumsAsStrings();
});
}
②:Configure中
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
// The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
app.UseHsts();
}
//设置全局跨域
app.UseCors(builder => builder.AllowAnyOrigin());
app.UseHttpsRedirection();
app.UseSwagger(c => { c.RouteTemplate = "swagger/{documentName}/swagger.json"; });
// 在这里面可以注入
app.UseSwaggerUI(options =>
{
options.ShowExtensions();
options.ValidatorUrl(null);
options.SwaggerEndpoint("/swagger/v1/swagger.json", "Aonaufly API V1");
options.DocExpansion(DocExpansion.None);
});
app.UseMvc();
}
三 :配置设置
①,到处项目XML , 加入1591禁止警告
②,将项目XML生成路径复制到项目根路径
copy $(TargetDir)WebAPIPoco.xml $(ProjectDir)WebAPIPoco.xml
③,重置默认网页为swagger , 默认是 api/values
四 :初始结果
五 : 测试
///
/// 带参数的get请求
///
///
///
/// 输入 : int
/// 输出 : string
///
///
/// ID号
/// String
/// 返回字符串
/// 如果id为空
// GET api/values/5
[HttpGet("{id}")]
[ProducesResponseType(201)]
[ProducesResponseType(400)]
public ActionResult Get(int id)
{
return "value";
}
结果:
标签:
.net webapi导出html,C#(.Net Core WebAPI)之API文档的生成(Swagger)相关推荐
- ASP.NET CORE 1.0 MVC API 文档用 SWASHBUCKLE SWAGGER实现
from:https://damienbod.com/2015/12/13/asp-net-5-mvc-6-api-documentation-using-swagger/ 代码生成工具: https ...
- .NET Core API文档管理组件 Swagger
Swagger这个优秀的开源项目相信大家都用过,不多介绍了,这里简单记录一下使用过程. 开源地址:https://github.com/domaindrivendev/Swashbuckle.AspN ...
- 标你妹怎么导出html,标你妹啊:PSD文档自动生成标注的工具
霸气外露的名字:标你妹啊!看来是想要表达设计师心中的呐喊,总之第一眼我是被这个名字所吸引了! 这是一款云端.一键自动完成所有标注数据的自动标注工具.Photoshop的设计师从此可以真正体验到自动化标 ...
- 如何使 WebAPI 自动生成漂亮又实用在线API文档
1.前言 1.1 SwaggerUI SwaggerUI 是一个简单的Restful API 测试和文档工具.简单.漂亮.易用(官方demo).通过读取JSON 配置显示API. 项目本身仅仅也只依赖 ...
- 第十二节:WebApi自动生成在线Api文档的两种方式
一. WebApi自带生成api文档 1. 说明 通过观察,发现WebApi项目中Area文件夹下有一个HelpPage文件夹,如下图,该文件夹就是WebApi自带的生成Api的方式,如果该文件夹没了 ...
- .NET Core 3.0 使用Nswag生成Api文档和客户端代码
摘要 在前后端分离.Restful API盛行的年代,完美的接口文档,成了交流的纽带.在项目中引入Swagger (也称为OpenAPI),是种不错的选择,它可以让接口数据可视化.下文将会演示 利用N ...
- 在ASP.NET Core Web API上使用Swagger提供API文档
我在开发自己的博客系统(http://daxnet.me)时,给自己的RESTful服务增加了基于Swagger的API文档功能.当设置IISExpress的默认启动路由到Swagger的API文档页 ...
- 在MyEclipse中使用javadoc导出API文档详解
本篇文档介绍如何在MyEclipse中导出javadoc(API)帮助文档,并且使用htmlhelp.exe和jd2chm.exe生成chm文档. 具体步骤如下: 打开MyEclipse,选中想要制作 ...
- Postman导出Api文档
Postman导出Api文档 新建接口文件夹 1.选择左边目录的New Collection,新建一个接口文件夹,建完后就会出现在左边的Collections的目录下 新建的接口存到文件夹里,这样才可 ...
最新文章
- 计算机是如何按照时钟来顺序工作的
- 通过onActivityResult()先跳转到联系人界面,然后把传回来的手机号显示到应用的EditText上...
- 开展project 正常的生活之路
- [Leetcode总结] 102.二叉树的层序遍历
- 遵循五大设计理念 打造出色设计师
- 全向移动机器人参数校准方法思路
- python selenium 获取接口数据
- JavaScript 原型精髓 #一篇就够系列
- dz3.4后台admin.php修改,Discuz X3.4论坛管理员无法登录后台,修改管理员账号密码的各种解决方法总结...
- 通俗易懂的图解机器学习之机器学习概论
- 反函数求导:自然对数 ln是怎么得到的;为什么自然对数的导数是 1/ x;arcsin 和 arccos 的导数求算
- 第三方软件测试报告 CMA CNAS标识的区别
- Localize Folders and Reports
- 又一个非常好的项目管理系统--ONES
- 拼多多砍价用户福利贴:通过python模拟操作进行拼多多砍价
- 按关键词搜索淘宝商品接口调用展示
- Linkis简单版安装教程
- http://blog.csdn.net/wxl1555/article/details/53916856
- 进入Oracle企业管理器
- Bp神经网络预测中trainlm算法和trainbr算法的应用
热门文章
- weblogic domain creation
- VS2010“.NET研究”中的调试技巧
- linux chown命令: 修改文件或目录的所有者或群组
- Windows 必知命令
- C++ 代码调试建议
- sudo rm /var/cache/apt/archives/lock sudo rm /var/lib/dpkg/lock
- ES6解析彩票项目学习记录(二)
- 百度地图和solr展示资源和附近等功能的实现 二
- Python Cookbook(第3版)中文版:15.18 传递已打开的文件给C扩展
- 0909 对编译原理的想法