.Net core 使用Swagger Api文档


1. 安装 

 2.添加配置Swagger

打开Startup.cs

 

 

//ConfigureServices 配置

 #region swagger
            services.AddSwaggerGen(q =>
            {
                q.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "JWTtest", Version = "v1" });
                var path = Path.GetDirectoryName((typeof(Program).Assembly.Location));
                var xmlpath = Path.Combine(path, "JWTDemo.xml");
                q.IncludeXmlComments(xmlpath);
            });
#endregion

  

 
//Configure配置
#region swagger
            app.UseSwaggerUI();
            app.UseSwagger();
 #endregion

  

 

 3.配置启动页xml

 

 

 这个时候可以运行了,得到以下结果

 

 因为没创建Controller所以没有显示我们的api下面添加测试的接口

 

 

 

 最后运行看看最终结果

4.番外篇(非Core的使用方式)

(1)NuGet引入Swagger的引用

 

 

 安装好以后,在App_Start目录下,会有一个SwaggerConfig.cs文件

 

 (2)创建汉化js.命名未swagger.js。并且右键点击属性设置为生成操作 ==嵌入的资源

'use strict';
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();
});

  

(3).配置xml和启动页

 

 


 

 (4).准备工作已经完成了,运行瞅瞅o(* ̄▽ ̄*)o

 

 

 

 

 

已经得到了我们想要的效果啦,收工。第一次写文章,不足之处还请见谅(●'◡'●)

 


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM