栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > .Net

.net搭建swagger

.Net 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

.net搭建swagger

 

引用:https://blog.csdn.net/wjf1997/article/details/90348921   前言:

  之前博客说了要给大家分享如何搭建swagger,那么这篇就给大家说说如何搭建!


什么是swagger?

   Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger让部署管理和使用功能强大的API从未如此简单。


swagger主要功能:

    1.接口,服务可视化,非常清晰
    2.做接口测试,方便测试人员使用


搭建步骤 1.按照我之前的博客,先创建WebAPI项目!
2打开NuGet管理器搜索并安装Swashbuckle和Swagger.Net、Swagger.Net.UI两项。
3.打开解决方案  属性-->生成,勾选XML文档文件,保存

                       


4. 在swaggerconfig文件的注册方法,去掉下面注释的这一句代码,用于在UI上加载生成的xml文档

                                        


5.添加 GetXmlCommentsPath方法
 
  1. private static string GetXmlCommentsPath()

  2. {

  3.  
  4. return string.Format(@{0}binWebApiSwagger.XML",

  5. System.AppDomain.CurrentDomain.BaseDirectory);

  6.  
  7. }

  8.  

                           


6.打开swggernet文件,修改下图的代码


7. 打开swggernet文件,注释掉下面的两行代码


8.在浏览器输入:http://localhost:端口号/swagger/ui/index 就可以看到界面了(端口号是你项目的端口号)

           

至此,swagger搭建完毕,下一篇博客介绍如何编写自己aip用于和前端交互,同时分享如何解决浏览器跨域问题!

 

namespace WebApplication1.Controllers
{
    [RoutePrefix("api/First")]
    public class FirstController : ApiController
    {

        [HttpGet, Route("getYourId/{yourId}")]
        public string first(string yourId)
        {
            return "is beautiful";
        }


    }
}

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/910080.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号