热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

【swaggerui】swaggerui在asp.netwebapicore中的应用

Swaggerui 可以为我们的webapi提供美观的在线文档,如下图: 实现步骤:NuGetPackages Install-PackageSwashbuckle.AspNetC

Swaggerui 可以为我们的webapi提供美观的在线文档,如下图:

【swaggerui】swaggerui在asp.net web api core 中的应用

 实现步骤:

  • NuGet Packages  Install-Package Swashbuckle.AspNetCore
  • 在startup文件中配置swagger

       

 1            // Register the Swagger generator, defining one or more Swagger documents
 2             services.AddSwaggerGen(c =>
 3             {
 4                 c.SwaggerDoc("v1", new Info
 5                 {
 6                     Version = "v1",
 7                     Title = "ToDo API",
 8                     Description = "A simple example ASP.NET Core Web API",
 9                     TermsOfService = "None",
10                     COntact= new Contact { Name = "Shayne Boyer", Email = "", Url = "https://twitter.com/spboyer" },
11                     License = new License { Name = "Use under LICX", Url = "https://example.com/license" }
12                 });
13 
14                 //Set the comments path for the swagger json and ui.
15                 var basePath = PlatformServices.Default.Application.ApplicationBasePath;
16                 var xmlPath = Path.Combine(basePath, "MyWebApiCore.xml");
17                 c.IncludeXmlComments(xmlPath);
18             });
19         }
20 
21         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
22         public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
23         {
24             loggerFactory.AddConsole(Configuration.GetSection("Logging"));
25             loggerFactory.AddDebug();
26 
27             app.UseMvc();
28             app.UseSwagger();
29             app.UseSwaggerUI(c =>
30             {
31                 c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
32             });
33         }

 

  • XML Comments,点击项目属性=》生成=》XML文档文件打勾,然后在你的action上添加注释【swaggerui】swaggerui在asp.net web api core 中的应用
            }

            ///


            /// 根据id获取
            ///

            ///
            ///
            ///
            /// Note that the id is an integer.
            ///

            [HttpGet("{id}")]
            public string Get(int id)
            {
                return "value";
            }

  • 运行项目,输入文档地址http://localhost:58911/swagger/【swaggerui】swaggerui在asp.net web api core 中的应用

    你可以选择方法进行在线测试

【swaggerui】swaggerui在asp.net web api core 中的应用


推荐阅读
  • 本文介绍如何使用阿里云的fastjson库解析包含时间戳、IP地址和参数等信息的JSON格式文本,并进行数据处理和保存。 ... [详细]
  • 本文将介绍如何编写一些有趣的VBScript脚本,这些脚本可以在朋友之间进行无害的恶作剧。通过简单的代码示例,帮助您了解VBScript的基本语法和功能。 ... [详细]
  • 本文详细介绍如何使用Python进行配置文件的读写操作,涵盖常见的配置文件格式(如INI、JSON、TOML和YAML),并提供具体的代码示例。 ... [详细]
  • 使用 Azure Service Principal 和 Microsoft Graph API 获取 AAD 用户列表
    本文介绍了一段通用代码示例,该代码不仅能够操作 Azure Active Directory (AAD),还可以通过 Azure Service Principal 的授权访问和管理 Azure 订阅资源。Azure 的架构可以分为两个层级:AAD 和 Subscription。 ... [详细]
  • UNP 第9章:主机名与地址转换
    本章探讨了用于在主机名和数值地址之间进行转换的函数,如gethostbyname和gethostbyaddr。此外,还介绍了getservbyname和getservbyport函数,用于在服务器名和端口号之间进行转换。 ... [详细]
  • 本文介绍了如何通过 Maven 依赖引入 SQLiteJDBC 和 HikariCP 包,从而在 Java 应用中高效地连接和操作 SQLite 数据库。文章提供了详细的代码示例,并解释了每个步骤的实现细节。 ... [详细]
  • 本文详细记录了在基于Debian的Deepin 20操作系统上安装MySQL 5.7的具体步骤,包括软件包的选择、依赖项的处理及远程访问权限的配置。 ... [详细]
  • 优化ListView性能
    本文深入探讨了如何通过多种技术手段优化ListView的性能,包括视图复用、ViewHolder模式、分批加载数据、图片优化及内存管理等。这些方法能够显著提升应用的响应速度和用户体验。 ... [详细]
  • Explore how Matterverse is redefining the metaverse experience, creating immersive and meaningful virtual environments that foster genuine connections and economic opportunities. ... [详细]
  • 本文详细介绍了如何解决Uploadify插件在Internet Explorer(IE)9和10版本中遇到的点击失效及JQuery运行时错误问题。通过修改相关JavaScript代码,确保上传功能在不同浏览器环境中的一致性和稳定性。 ... [详细]
  • 本文详细介绍了如何在Linux系统上安装和配置Smokeping,以实现对网络链路质量的实时监控。通过详细的步骤和必要的依赖包安装,确保用户能够顺利完成部署并优化其网络性能监控。 ... [详细]
  • XNA 3.0 游戏编程:从 XML 文件加载数据
    本文介绍如何在 XNA 3.0 游戏项目中从 XML 文件加载数据。我们将探讨如何将 XML 数据序列化为二进制文件,并通过内容管道加载到游戏中。此外,还会涉及自定义类型读取器和写入器的实现。 ... [详细]
  • 本文深入探讨了Linux系统中网卡绑定(bonding)的七种工作模式。网卡绑定技术通过将多个物理网卡组合成一个逻辑网卡,实现网络冗余、带宽聚合和负载均衡,在生产环境中广泛应用。文章详细介绍了每种模式的特点、适用场景及配置方法。 ... [详细]
  • 在使用 DataGridView 时,如果在当前单元格中输入内容但光标未移开,点击保存按钮后,输入的内容可能无法保存。只有当光标离开单元格后,才能成功保存数据。本文将探讨如何通过调用 DataGridView 的内置方法解决此问题。 ... [详细]
  • 本文详细解析了Python中的os和sys模块,介绍了它们的功能、常用方法及其在实际编程中的应用。 ... [详细]
author-avatar
老娘叫凌凌_523
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有