当前位置:首页 > 服务端 > C# Swagger 生成接口文档

C# Swagger 生成接口文档

2022年09月16日 19:13:02服务端6

一直听说Swagger是做Web API文档的好工具,这次手里暂时没什么事,类体验下它的强大之处。下面是使用Swashbuckle.net 给asp.net web API添加文档的简要步骤。

参考地址:http://www.jianshu.com/p/3329b4126886

项目引入Swagger

Swashbuckle是Swagger在dotnet环境中的实现,在ASP.net项目中加入后即可支持Swagger/UI。5.X版本支持ASP.net, 6.X(beta)版本支持ASP.net Core. 目前项目使用ASP.net for IIS,所以使用了5.6的版本。 关于selfhost和Owin Swashbuckle 的readme有很清楚的描述,可以去查看源码

使用nuget加入Swashbuckle的引用

C# Swagger 生成接口文档 _ JavaClub全栈架构师技术笔记

 

安装好以后,在App_Start目录下,会有一个SwaggerConfig.cs文件,SwaggerConfig类通过[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]启动时运行。

nuget添加完引用,无须任何配置,编译后,访问 http://localhost:52079/swagger(这里按照自己的项目启动端口更改) 即可看到所有API的文档说明。界面如图所示:

C# Swagger 生成接口文档 _ JavaClub全栈架构师技术笔记

 

SwaggerConfig简单介绍

SwaggerConfig.cs文件会自动添加到项目的App_Start目录下,代码本身包含大量注释掉的代码,清除后,代码如下:

C# Swagger 生成接口文档 _ JavaClub全栈架构师技术笔记

 

相关工程需要生成XML文档

C# Swagger 生成接口文档 _ JavaClub全栈架构师技术笔记

 

在SwaggerConfig 的Register方法的EnableSwagger匿名函数中加上对应的XML文件,修改如下: 

public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;
            //获取项目文件路径
            var baseDirectory = System.Web.HttpContext.Current.Server.MapPath("~/App_Data");
            var commentsFileName = Assembly.GetExecutingAssembly().GetName().Name + ".XML";
            var commentsFile = Path.Combine(baseDirectory, commentsFileName);

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        //用于启用和设置Swagger的配置信息。
                        c.SingleApiVersion("v1", "APIUI");
                        //单个xml文件注释读取
                        c.IncludeXmlComments(commentsFile);
                        //多个xml文件注释读取 使用多个时注释单个
                        //DirectoryInfo dirct = new DirectoryInfo(baseDirectory);
                        //foreach (var item in dirct.GetFiles())
                        //{
                        //    if (item.Name.Contains(".xml"))
                        //    {
                        //        var name = baseDirectory + @"\" + item.Name;
                        //        c.IncludeXmlComments(name);
                        //    }
                        //}
                    })
                .EnableSwaggerUi(c =>
                    {
                        //用于启用UI界面。

                    });
        }
    }

 

上述代码把api工程的XML注释加入到Swagger中。一般我们会把viewmodel或者其他类型定义在不同的工程中,通过下面的代码可以继续加入其它xml注释文件。(对应功能需要启用XML文档文件生成)

注:如果System.Web.HttpContext.Current.Server.MapPath获取项目路径报错的话改用下面这句代码

 var baseDirectory = string.Format("{0}App_Data", System.Web.HttpRuntime.AppDomainAppPath);

汉化 SwaggerUI 

新增js,内容如下

C# Swagger 生成接口文档 _ JavaClub全栈架构师技术笔记
'use strict';  
  
/** 
 * Translator for documentation pages. 
 * 
 * To enable translation you should include one of language-files in your index.html 
 * after <script src='lang/translator.js' type='text/javascript'></script>. 
 * For example - <script src='lang/ru.js' type='text/javascript'></script> 
 * 
 * If you wish to translate some new texsts you should do two things: 
 * 1. Add a new phrase pair ("New Phrase": "New Translation") into your language file (for example lang/ru.js). It will be great if you add it in other language files too. 
 * 2. Mark that text it templates this way <anyHtmlTag data-sw-translate>New Phrase</anyHtmlTag> or <anyHtmlTag data-sw-translate value='New Phrase'/>. 
 * The main thing here is attribute data-sw-translate. Only inner html, title-attribute and value-attribute are going to translate. 
 * 
 */  
window.SwaggerTranslator = {  
    _words: [],  
  
    translate: function () {  
        var $this = this;  
        $('[data-sw-translate]').each(function () {  
            $(this).html($this._tryTranslate($(this).html()));  
            $(this).val($this._tryTranslate($(this).val()));  
            $(this).attr('title', $this._tryTranslate($(this).attr('title')));  
        });  
    },  
  
    _tryTranslate: function (word) {  
        return this._words[$.trim(word)] !== undefined ? this._words[$.trim(word)] : word;  
    },  
  
    learn: function (wordsMap) {  
        this._words = wordsMap;  
    }  
};  
  
  
/* jshint quotmark: double */  
window.SwaggerTranslator.learn({  
    "Warning: Deprecated": "警告:已过时",  
    "Implementation Notes": "实现备注",  
    "Response Class": "响应类",  
    "Status": "状态",  
    "Parameters": "参数",  
    "Parameter": "参数",  
    "Value": "值",  
    "Description": "描述",  
    "Parameter Type": "参数类型",  
    "Data Type": "数据类型",  
    "Response Messages": "响应消息",  
    "HTTP Status Code": "HTTP状态码",  
    "Reason": "原因",  
    "Response Model": "响应模型",  
    "Request URL": "请求URL",  
    "Response Body": "响应体",  
    "Response Code": "响应码",  
    "Response Headers": "响应头",  
    "Hide Response": "隐藏响应",  
    "Headers": "头",  
    "Try it out!": "试一下!",  
    "Show/Hide": "显示/隐藏",  
    "List Operations": "显示操作",  
    "Expand Operations": "展开操作",  
    "Raw": "原始",  
    "can't parse JSON.  Raw result": "无法解析JSON. 原始结果",  
    "Model Schema": "模型架构",  
    "Model": "模型",  
    "apply": "应用",  
    "Username": "用户名",  
    "Password": "密码",  
    "Terms of service": "服务条款",  
    "Created by": "创建者",  
    "See more at": "查看更多:",  
    "Contact the developer": "联系开发者",  
    "api version": "api版本",  
    "Response Content Type": "响应Content Type",  
    "fetching resource": "正在获取资源",  
    "fetching resource list": "正在获取资源列表",  
    "Explore": "浏览",  
    "Show Swagger Petstore Example Apis": "显示 Swagger Petstore 示例 Apis",  
    "Can't read from server.  It may not have the appropriate access-control-origin settings.": "无法从服务器读取。可能没有正确设置access-control-origin。",  
    "Please specify the protocol for": "请指定协议:",  
    "Can't read swagger JSON from": "无法读取swagger JSON于",  
    "Finished Loading Resource Information. Rendering Swagger UI": "已加载资源信息。正在渲染Swagger UI",  
    "Unable to read api": "无法读取api",  
    "from path": "从路径",  
    "server returned": "服务器返回"  
});  
  
  
$(function () {  
    window.SwaggerTranslator.translate();  
});  
View Code

注:右键点击该js文件修改属性为嵌入的资源

C# Swagger 生成接口文档 _ JavaClub全栈架构师技术笔记

修改 SwaggerConfig文件:修改如下

 public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;
            //获取项目文件路径
            var baseDirectory = AppDomain.CurrentDomain.BaseDirectory + @"\App_Data\";
            var commentsFileName = Assembly.GetExecutingAssembly().GetName().Name + ".XML";

            var commentsFile = Path.Combine(baseDirectory, commentsFileName);

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        //用于启用和设置Swagger的配置信息。
                        c.SingleApiVersion("v1", "APIUI");
                        //获取项目指定路径下xml文件
                        c.IncludeXmlComments(commentsFile);
                    })
                .EnableSwaggerUi(c =>
                    {
                        //用于启用UI界面上的东西。
                        //加载汉化的js文件,注意 swagger.js文件属性必须设置为“嵌入的资源”。 APIUI.Scripts.swagger.js依次是:项目名称->文件夹->js文件名 
                        c.InjectJavaScript(Assembly.GetExecutingAssembly(), "APIUI.Scripts.swagger.js");
                    });
        }

 效果如下:

C# Swagger 生成接口文档 _ JavaClub全栈架构师技术笔记

 在API中显示返回的实体类模型跟注释

在方法上加入特性SwaggerResponse,这里的model是实体类

[SwaggerResponse(HttpStatusCode.OK, Type = typeof(Model))]

效果如下:

C# Swagger 生成接口文档 _ JavaClub全栈架构师技术笔记

 

 

 

 

作者:ice.ko
来源链接:https://www.cnblogs.com/miskis/p/7561249.html

版权声明:
1、JavaClub(https://www.javaclub.cn)以学习交流为目的,由作者投稿、网友推荐和小编整理收藏优秀的IT技术及相关内容,包括但不限于文字、图片、音频、视频、软件、程序等,其均来自互联网,本站不享有版权,版权归原作者所有。

2、本站提供的内容仅用于个人学习、研究或欣赏,以及其他非商业性或非盈利性用途,但同时应遵守著作权法及其他相关法律的规定,不得侵犯相关权利人及本网站的合法权利。
3、本网站内容原作者如不愿意在本网站刊登内容,请及时通知本站(javaclubcn@163.com),我们将第一时间核实后及时予以删除。


本文链接:https://www.javaclub.cn/server/42208.html

标签: Swagger
分享给朋友:

“C# Swagger 生成接口文档” 的相关文章

SpringBoot整合Swagger2

SpringBoot整合Swagger2

相信各位在公司写API文档数量应该不少,当然如果你还处在自己一个人开发前后台的年代,当我没说,如今为了前后台更好的对接,还是为了以后交接方便,都有要求写API文档。   手写Api文档的几个痛点: 文档需要更新的时候,需要再次发送...

替换swagger-ui,选择款神器—knife4j

替换swagger-ui,选择款神器—knife4j

    一、介绍 knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案(在非Java项目中也提供了前端UI的增强解决方案),前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一样小...

浅析如何在Nancy中使用Swagger生成API文档

浅析如何在Nancy中使用Swagger生成API文档

介绍了如何在Nancy中使用Swagger生成一份API文档,并且处理在安全验证方面遇到的问题。 前言 上一篇博客介绍了使用Nancy框架内部的方法来创建了一个简单到不能再简单的Document。但是还有许许多多的不足。 为了能稍微完善一下这个Docume...

.net core在Ocelot网关中统一配置Swagger

.net core在Ocelot网关中统一配置Swagger

最近在做微服务的时候,由于我们是采用前后端分离来开发的,提供给前端的直接是Swagger,如果Swagger分布在各个API中,前端查看Swagger的时候非常不便,因此,我们试着将Swagger集中放到网关中。 这里我用两个API项目(一个BasicDataApi,一个User...

Swagger-UI展示接口

Swagger-UI展示接口

简单介绍API的管理工具Swagger的UI模块。 简介:swagger ui就是一个能整合到项目中让api的注释能够生成到一个网页上。能简单测试和给前端看。 第一步:添加引用 打开NuGet程序包管理器,搜索Swagger。安装搜索出来的这个Swashbuckle。...

swagger整合springboot的使用

swagger整合springboot的使用

什么是swagger? Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口,可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服...

.NET Core和Swagger 生成 Api 文档

.NET Core和Swagger 生成 Api 文档

测试/生产环境的BUG 这里更新一下在本地调试正常,在INT/PROD上抛错,错误信息为: /**/.xml(Swagger json file) 文件找不到,在startup 里builder 的时候抛出错误。 解决方案: 编辑.csproj文件,修改输出路径...

解决 asp.net core swagger nginx 代理转发后,添加中间路径导致swagger页面无法访问的问题  Swashbuckle

解决 asp.net core swagger nginx 代理转发后,添加中间路径导致swagger页面无法访问的问题 Swashbuckle

通过代理转发后,webapi的swagger无法访问,本质原因是代理后url路径发生变化导致swagger无法正常定位资源。 一般而言代理转发如果发布到网址的根路径下,不会发生这种问题,但是如果添加了中间路径,则会出现此类问题,如: http://some-site.com/swagg...

在SpringBoot中Swagger配置及使用

在SpringBoot中Swagger配置及使用

Swagger号称世界上最流行的Api框架,它是RestFul 风格的Api。文档在线自动生成工具:Api文档与API定义同步更新。可以直接运行,能在线测试API接口;支持多种编程语言:(Java、PHP等)。 官网:https://swagger.io/ 在项目中使用Sw...

Asp.Net MVC项目集成Swagger

Asp.Net MVC项目集成Swagger

  公司最近的项目使用mvc+webapi,采取前后端分离的方式,后台提供API接口给前端开发人员。这个过程中遇到一个问题后台开发人员怎么提供接口说明文档给前端开发人员,之前一直使用的是word文档方式进行交流,效率低下而且不利于维护。为了解决这个问题,经过一番研究,引起我注意的有两种...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。