我的编程空间,编程开发者的网络收藏夹
学习永远不晚

Swagger怎么使用

短信预约 -IT技能 免费直播动态提醒
省份

北京

  • 北京
  • 上海
  • 天津
  • 重庆
  • 河北
  • 山东
  • 辽宁
  • 黑龙江
  • 吉林
  • 甘肃
  • 青海
  • 河南
  • 江苏
  • 湖北
  • 湖南
  • 江西
  • 浙江
  • 广东
  • 云南
  • 福建
  • 海南
  • 山西
  • 四川
  • 陕西
  • 贵州
  • 安徽
  • 广西
  • 内蒙
  • 西藏
  • 新疆
  • 宁夏
  • 兵团
手机号立即预约

请填写图片验证码后获取短信验证码

看不清楚,换张图片

免费获取短信验证码

Swagger怎么使用

今天小编给大家分享一下Swagger怎么使用的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。

Swagger怎么使用

  Swagger可以很方便的为发布的WebApi自动生成优雅的文档,不需额外自己编写,只需为项目配置好,是一个很好用的工具。

  1、使用HuGet导入Swashbuckle包

  2、修改SwaggerConfig.cs

  导入Swashbuckle后会自动在站点的App_Start文件夹下生成SwaggerConfig.cs,用于配置Swagger页面。配置的东西很多,下面只列举我个人需要的简单的配置(因为其他没研究)。

  1publicclassSwaggerConfig

  2{

  3publicstaticvoidRegister()

  4{

  5varthisAssembly=typeof(SwaggerConfig).Assembly;

  6

  7GlobalConfiguration.Configuration

  8.EnableSwagger(c=>

  9{

  10c.SingleApiVersion("v1","MyWebApi").Contact(x=>

  11{

  12x.Name("Bobbie");//配置界面头部描述

  13});

  14

  15c.IncludeXmlComments(GetXmlCommentsPath("/bin/WarRoom.WebApi.XML"));//配置模板XML路径

  16

  17})

  18.EnableSwaggerUi(c=>

  19{

  c.InjectJavaScript(Assembly.GetExecutingAssembly(),"MyWebApi.Scripts.Swagger_CN.js");//配置汉化js文件

  20});

  21}

  22

  23privatestaticstringGetXmlCommentsPath(stringXmlPath)

  24{

  25return$@"{System.AppDomain.CurrentDomain.BaseDirectory}"+XmlPath;

  26}

  27}

  3、配置项目属性

  主要是设置“生成”下的几个配置,就是我画红框框的,下面解释一下几个配置的作用:

  (1)禁止警告1591是属于禁止缺少注释的警告的,不然没有头部注释的类、函数都会有警告的下划线,看着不舒服(但该警告不影响使用)。

  (2)勾选XML文档文件,会自动生成一个路径,这个路径要于SwaggerConfig.cs中配置的一致:

  c.IncludeXmlComments(GetXmlCommentsPath("/bin/WarRoom.WebApi.XML"));

  由此其实已经配置完成,下面进行测试:

  4、测试

  新建一个Controller,文件名为DemoController.cs:

  1publicclassDemoController:ApiController

  2{

  3///<summary>

  4///我就是PostTest方法

  5///</summary>

  6///<paramname="name">参数1</param>

  7///<returns></returns>

  8[HttpGet]

  9publicstringPostTest(stringname)

  10{

  11stringresult="Hello"+name;

  12returnresult;

  13}

  然后运行,访问localhost:27827/Swagger(网址端口看自己的项目),可以看到如下界面就是成功了:

  页面会将接口路径、接口函数、注释、参数等基本信息都自动生成,还提供接口测试功能(单击TryitOut),可以测试接口(可直接输入参数)。

  5、汉化

  有些朋友喜欢中文,这边也测试一下汉化的功能,主要就是添加一个汉化功能的JS文件,并在SwaggerConfig.cs配置导入即可:

  (1)新建名为Swagger_CN.js的文件,放在Scripts文件夹下:

  1'usestrict';

  2

  15window.SwaggerTranslator={

  16_words:[],

  17translate:function(){

  18var$this=this;

  19$('[data-sw-translate]').each(function(){

  20$(this).html($this._tryTranslate($(this).html()));

  21$(this).val($this._tryTranslate($(this).val()));

  22$(this).attr('title',$this._tryTranslate($(this).attr('title')));

  23});

  24},

  25_tryTranslate:function(word){

  26returnthis._words[$.trim(word)]!==undefined?this._words[$.trim(word)]:word;

  27},

  28learn:function(wordsMap){

  29this._words=wordsMap;

  30}

  31};

  32

  33window.SwaggerTranslator.learn({

  34"Warning:Deprecated":"警告:已过时",

  35"ImplementationNotes":"实现备注",

  36"ResponseClass":"响应类",

  37"Status":"状态",

  38"Parameters":"参数",

  39"Parameter":"参数",

  40"Value":"值",

  41"Description":"描述",

  42"ParameterType":"参数类型",

  43"DataType":"数据类型",

  44"ResponseMessages":"响应消息",

  45"HTTPStatusCode":"HTTP状态码",

  46"Reason":"原因",

  47"ResponseModel":"响应模型",

  48"RequestURL":"请求URL",

  49"ResponseBody":"响应体",

  50"ResponseCode":"响应码",

  51"ResponseHeaders":"响应头",

  52"HideResponse":"隐藏响应",

  53"Headers":"头",

  54"Tryitout!":"试一下!",

  55"Show/Hide":"显示/隐藏",

  56"ListOperations":"显示操作",

  57"ExpandOperations":"展开操作",

  58"Raw":"原始",

  59"can'tparseJSON.Rawresult":"无法解析JSON.原始结果",

  60"ModelSchema":"模型架构",

  61"Model":"模型",

  62"apply":"应用",

  63"Username":"用户名",

  64"Password":"密码",

  65"Termsofservice":"服务条款",

  66"Createdby":"创建者",

  67"Seemoreat":"查看更多:",

  68"Contactthedeveloper":"联系开发者",

  69"apiversion":"api版本",

  70"ResponseContentType":"响应内容类型",

  71"fetchingresource":"正在获取资源",

  72"fetchingresourcelist":"正在获取资源列表",

  73"Explore":"浏览",

  74"ShowSwaggerPetstoreExampleApis":"显示SwaggerPetstore示例Apis",

  75"Can'treadfromserver.Itmaynothavetheappropriateaccess-control-originsettings.":"无法从服务器读取。可能没有正确设置access-control-origin。",

  76"Pleasespecifytheprotocolfor":"请指定协议:",

  77"Can'treadswaggerJSONfrom":"无法读取swaggerJSON于",

  78"FinishedLoadingResourceInformation.RenderingSwaggerUI":"已加载资源信息。正在渲染SwaggerUI",

  79"Unabletoreadapi":"无法读取api",

  80"frompath":"从路径",

  81"serverreturned":"服务器返回"

  82});

  83$(function(){

  84window.SwaggerTranslator.translate();

  85});

  (2)将Swagger_CN.js设置为“嵌入的资源”

  属性->生成操作->设置为“嵌入的资源”

  (3)配置SwaggerConfig.cs

  在EnableSwaggerUi下添加:

  c.InjectJavaScript(Assembly.GetExecutingAssembly(),"MyWebApi.Scripts.Swagger_CN.js");

  注:MyWebApi.Scripts.Swagger_CN.js格式为:项目名.文件夹名.JS文件名

  这个可以看上面的SwaggerConfig.cs文件配置。然后再次运行

以上就是“Swagger怎么使用”这篇文章的所有内容,感谢各位的阅读!相信大家阅读完这篇文章都有很大的收获,小编每天都会为大家更新不同的知识,如果还想学习更多的知识,请关注编程网行业资讯频道。

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

Swagger怎么使用

下载Word文档到电脑,方便收藏和打印~

下载Word文档

猜你喜欢

Laravel Swagger怎么使用

这篇“Laravel Swagger怎么使用”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“Laravel Swagger怎么
2023-06-29

Swagger工具怎么使用

Swagger工具是一种用于构建、文档化和测试RESTful API的工具。下面是Swagger工具的使用步骤:1. 安装Swagger工具:可以通过npm安装Swagger命令行工具。在终端中运行以下命令进行安装:```npm insta
2023-09-22

Spring Boot中怎么使用Swagger

小编给大家分享一下Spring Boot中怎么使用Swagger,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!Swagger 简介Swagger 是一个方便 API 开发的框架,它有以下优点:自动生成在线文档,后端开发人员
2023-06-20

vue的swagger-ui怎么使用

这篇文章主要介绍了vue的swagger-ui怎么使用的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇vue的swagger-ui怎么使用文章都会有所收获,下面我们一起来看看吧。think-swagger-ui-
2023-06-29

springboot项目中怎么使用Swagger

今天小编给大家分享一下springboot项目中怎么使用Swagger的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。1、Sw
2023-07-05

使用SpringMVC怎么对Swagger进行整合

这篇文章将为大家详细讲解有关使用SpringMVC怎么对Swagger进行整合,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。配置1、引入相关jar包:
2023-05-31

在laravel 5.6 中怎样使用swagger

这篇文章主要介绍在laravel 5.6 中怎样使用swagger,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!Laravel 是什么Laravel 是一套简洁、优雅的PHP Web开发框架。它可以让你从面条一样杂乱
2023-06-06

SpringBoot整合接口管理工具Swagger怎么使用

这篇“SpringBoot整合接口管理工具Swagger怎么使用”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“SpringB
2023-07-06

一文探讨Node.js项目中怎么使用Koa2集成Swagger

在本文中,我们将探讨如何在Node.js项目中使用Koa2集成Swagger,以自动生成API文档。我们将介绍Swagger的基本概念、相关的NPM包,并通过详细的代码示例和解释来演示整个过程。 什么
2023-05-14

编程热搜

目录