netcore项目使用swagger开发

首先我创建一个netcore项目,我使用的工具是vs2019

这里需要注意的是,看情况选择是否开启身份验证,一般是没有需求的,这里因为我是测试使用所以需要取消勾兑为https配置,并且我没有启用docker支持,因为这个

项目我只是写接口,所以我创建的是一个webapi项目

点击创建,生成项目

因为要使用swagger,所以我们需要安装指定的组件包,现在我们使用nuget安装组件

安装后我们需要去startup中进行配置

首先我们在ConfigureServices中尽心注册swagger服务

//注册swagger服务
services.AddSwaggerGen(c =>
{
// 添加文档信息
c.SwaggerDoc("v1", new Info { Title = "CoreWebApi", Version = "v1" });
});

然后我们在Configure中启用swagger中间件

// 启用Swagger中间件
app.UseSwagger();

// 配置SwaggerUI
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "CoreWebApi");
c.RoutePrefix = string.Empty;
});

接着配置的xml文件

接着我们运行我们的项目

已经看到我们已经出现了swagger的界面,那么我们尝试一下调用

忽然发现我们这个上面并没有每个接口的备注,这是咋回事那?看来我们还需要配置一些东西

我们接着去ConfigureServices中配置

再次运行项目查看

如我们所愿,备注都已经出来了

原文地址:https://www.cnblogs.com/ITzhangyunpeng/p/11478277.html

时间: 2024-11-10 22:58:24

netcore项目使用swagger开发的相关文章

从壹开始学习 NetCore 新篇章 ║ Blog.Core 开发社之招募计划书

宫 哈喽大家好,国庆马上就要来了,在新的第四季度来临之际,祝大家年末能顺顺利利,解决所有的难题.大家可能从我的标题里也能看的出来,老张又要耍花样,搞事情了,近来随着 netcore 3.0 的正式推出,Dot net 将迎来了一次重大转折点,能不能在未来技术领域三分天下,就看这次以后了,所以我打算进一步对 netcore 进行学习和开发,但是毕竟我一个人的力量是有限的,而且群里的小伙伴也慢慢的增多了,我平时也要抽出来一部分时间来解答和点拨,所以就需要成立一个组织,一个开发社,来一起搞开发,主要是

HelloX项目github协同开发指南

概述 为了提高协同开发效率,HelloX项目已托管到github站点上. 依据眼下的开发进展,创建了下列几个子项目: HelloX操作系统内核项目:https://github.com/hellox-project/HelloX_Kernel.git HelloX操作系统GUI模块项目:https://github.com/hellox-project/HelloX_GUI.git 面向STM32的移植版:https://github.com/hellox-project/HelloX_STM3

Django安装 测试、导入项目以及运行开发服务器

安装Django  下载Django包,解压缩. CMD 进入解压路径下. 执行:python setup.py install 增加环境变量: C:\Python27\Scripts 测试django是否安装成功 shell import django django.VERSION 把Django导入项目 CMD 进入项目路径 执行 django-admin.py startproject 项目名  运行开发服务器 项目Django路径下  python manage.py runserver

基于plusgantt的项目管理系统实战开发

<基于plusgantt的项目管理系统实战开发(Spring3+JDBC+RMI的架构.自定义工作流)> 课程讲师:Adam 课程分类:Java 适合人群:中级 课时数量:37课时 用到技术:Spring 3+JDBC+RMI的架构.jquery.工作流 涉及项目:项目管理系统 咨询QQ:1337192913(小公子) 本课程是某航空研究所的真正项目的缩影.在课程中,将实际项目的业务进行了缩减,但是主要的技术点全部都讲解到了. 课程内容虽然不多,但是麻雀虽小五脏俱全,通过学习本课程,可以掌握到

《结对-结对编项目作业名称-开发环境搭建过程》

<结对-结对编项目作业名称-开发环境搭建过程>要求:选择适合的开发工具,搭建开发环境及环境搭建过程. 1.开发工具:Python Python,是一种面向对象.直译式计算机编程语言,具有近二十年的发展历史,成熟且稳定.它包含了一组完善而且容易理解的标准库,能够轻松完成很多常见的任务.它的语法简捷和清晰,尽量使用无异义的英语单词,与其它大多数程序设计语言使用大括号不一样,它使用缩进来定义语句块.与Scheme.Ruby.Perl.Tcl等动态语言一样,Python具备垃圾回收功能,能够自动管理内

Ubuntu 16.04 安装Docker,部署NetCore项目

国庆节前最后一篇. 准备工作: 检查版本,因为Docker官方明确说了一下,必须是64位的Ubuntu,并且kernel版本大于3.10:如果你不能满足这个版本,恐怕是不能如愿了. [email protected]:~$ uname -r 4.4.0-34-generic 如果你版本过低,可以采用下面的命令升级: sudo apt-get update sudo apt-get upgrade 或者使用root权限处理都可以. 安装Docker 其实应该只要一句指令即可 [email prot

【课程分享】基于plusgantt的项目管理系统实战开发(Spring3+JDBC+RMI的架构、自定义工作流)

课程讲师:张弘 课程分类:Java 适合人群:中级 课时数量:37课时 用到技术:Spring 3+JDBC+RMI的架构.jquery.工作流 涉及项目:项目管理系统 更新程度:完成 QQ  1269532055 本课程是某航空研究所的真正项目的缩影.实际项目价值217万,在课程中,将实际项目的业务进行了缩减,但是主要的技术点全部都讲解到了.课程内容虽然不多,但是麻雀虽小五脏俱全,通过学习本课程,可以掌握到企业信息化办公系统的主要开发方法和设计思路,并且学习强大的自定义工作流中间件的内容,掌握

Thrift项目Server端开发流程

Thrift项目Server端开发流程 首先,先了解工程中所有包的功能(见下图) 该图为用户中心项目的目录结构,以下依次介绍. 1.     src/main/java com.framework:该目录存放着所有系统所需要的共同的一些类. com.user:这个包下面放着本小组的功能代码. dao:该层主要存放着调用数据库层的方法 entity:业务实体bean mapper:业务sql service:thrift接口的实现类 thrift:thrift的IDL生成的java文件 com.u

天然工坊平台项目模式系统开发

随着微信产品的日趋成熟,各行各业的企业都蠢蠢欲动,想吃下微信这款蛋糕,湖南天然工坊就开启了一条新型的互联网之路,该公司研发的竹妃纸巾,通过微信公众号平台以及搭载的自有web电商平台,通过口碑引爆传播,天然工坊从竹妃纸巾切入新兴消费品市场,在产品主张.销售模式都突破了以往既定的路径.天然工坊平台项目模式系统开发找何经理.天然工坊系统项目开发.天然工坊模式平台项目开发等--(188.264.66502 微/电) 最近几年随着响应式布局的发展,一次开发多次使用,自适应屏幕的响应式网站的需求越来越多.但