swagger

　　上一篇讲了VsCode的简单介绍,本次主要讲一下VsCode如何创建WebApi项目,及Swagger在线接口文档的使用. 一.创建WebApi项目. 首先打开VsCode 终端控制台,并将工作区指向自己的项目文件夹(手动创建项目文件夹),可输入"cd 项目文件路径"自动进行修改. 指向自已的项目文件夹后,在终端控制台中,输入"dotnet new webapi"即可创建一个空的WebApi项目模板. 如下图,是已经创建成功了的,可以看到,里面已有一个示例控制器了. 创建成功后,该接口是可以直接在浏览器正常访问的了,为了方便查看,下一步,开始创建Swagger在线接口. 二.集成Swagger在线接口文档. 1.首先Swagger程序集引用.在终端控制台输入"dotnet add package Swashbuckle.AspNetCore"即可自动添加程序到项目中.如需指定版本,可在后面追加 " -v 2.0.1"(版本号). 2.打开项目中的Startup.cs文件. 找到ConfigureServices方法,添加Swagger服务并配置文档信息. public void ConfigureServices (IServiceCollection services) { // 注册Swagger服务 services.AddSwaggerGen (c => { //

0.学习目标 会调用订单系统接口 实现订单结算功能 实现微信支付功能 1.订单系统接口 我们不做开发，只讲解 1.1.导入订单服务 把课前资料提供的 leyou-order 复制到 D:\heima\code\leyou 目录。 然后在工程内导入： 然后导入module： 选择导入module： 选择目录中的 ly-order ： 打开父工程leyou的pom文件，添加 ly-order 模块： 1.2.Swagger-UI 丝袜哥 1.2.1.什么是OpenAPI 随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、前后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。 前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要。 没有API文档工具之前，大家都是手写API文档的，在什么地方书写的都有，而且API文档没有统一规范和格式，每个公司都不一样。这无疑给开发带来了灾难。 OpenAPI规范（OpenAPI Specification 简称OAS）是Linux基金会的一个项目，试图通过定义一种用来描述API格式或API定义的语言，来规范RESTful服务开发过程。目前V3.0版本的OpenAPI规范已经发布并开源在github上 。 官网：https://github.com/OAI/OpenAPI

一. swagger是什么？能干什么？ swagger官网： https://swagger.io/tools/ 。 就是把相关的信息存储在它定义的描述文件里面(yml或json格式)，再通过维护这个描述文件可以去更新接口文档，以及生成各端代码。而Springfox-swagger,则可以通过扫描代码去生成这个描述文件，连描述文件都不需要再去维护了。所有的信息，都在代码里面了。 代码即接口文档，接口文档即代码。 二. swagger2常用注解： swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。 @Api：修饰整个类，描述Controller的作用 @ApiOperation：描述一个类的一个方法，或者说一个接口 @ApiParam：单个参数描述 @ApiModel：用对象来接收参数 @ApiProperty：用对象接收参数时，描述对象的一个字段 @ApiResponse：HTTP响应其中1个描述 @ApiResponses：HTTP响应整体描述 @ApiIgnore：使用该注解忽略这个API @ApiError ：发生错误返回的信息 @ApiImplicitParam：一个请求参数 @ApiImplicitParams：多个请求参数 @Api：用在请求的类上，表示对类的说明 tags="说明该类的作用，可以在UI界面上看到的注解" value

1、背景 相信无论是前端还是后端开发，都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力，经常来不及更新。其实无论是前端调用后端，还是后端调用后端，都期望有一个好的接口文档。但是这个接口文档对于程序员来说，就跟注释一样，经常会抱怨别人写的代码没有写注释，然而自己写起代码起来，最讨厌的，也是写注释。所以仅仅只通过强制来规范大家是不够的，随着时间推移，版本迭代，接口文档往往很容易就跟不上代码了。 2、Swagger是什么？它能干什么？ 发现了痛点就要去找解决方案。解决方案用的人多了，就成了标准的规范，这就是Swagger的由来。通过这套规范，你只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，生成多种语言的客户端和服务端的代码，以及在线接口调试页面等等。这样，如果按照新的开发模式，在开发新版本或者迭代版本的时候，只需要更新Swagger描述文件，就可以自动生成接口文档和客户端服务端代码，做到调用端代码、服务端代码以及接口文档的一致性。 但即便如此，对于许多开发来说，编写这个yml或json格式的描述文件，本身也是有一定负担的工作，特别是在后面持续迭代开发的时候，往往会忽略更新这个描述文件，直接更改代码。久而久之

引入Nuget包 Swashbuckle.AspNetCore.SwaggerGen Swashbuckle.AspNetCore.SwaggerUI 配置Startup 配置 ConfigureServices services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Version = "v1", Title = ApiName }); c.OrderActionsBy(a => a.RelativePath); var xmlFile = "WikiServer.xml";//文件名来源于项目属性==》生成==》输出==》XML文档文件 var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); // 启用xml注释. 该方法第二个参数启用控制器的注释，默认为false. c.IncludeXmlComments(xmlPath, true); }); 配置 Configure app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint($"/swagger/v1/swagger.json", $"{ApiName} V1");

.Net Core3.1下使用Swagger搭建web api项目 前言：微软于前天发布.net core 3.1正式版,并将长期支持3.1。所以我听到这个消息后就急忙下载.net core 3.1的SDK和Runtime,应该是公司最先用3.1的攻城狮了😄。 OK！废话少说，今天的目的是基于.net core 3.1建一个web api的项目 先下载.net core 3.1的SDK(开发.net core项目时会用到)和Runtime(用来运行.net core的应用程序) 地址： https://dotnet.microsoft.com/download/visual-studio-sdks?utm_source=getdotnetsdk&utm_medium=referral 创建ASP.NET Core web项目 ps:不要选错了😂 这里说一下项目目录下的各个文件的作用 引入Swashbuckle.AspNetCore程序包 执行以下命令 Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4 添加 并配置Swagger中间件 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version

一、克隆、完成初始化 依次执行： 克隆 拷贝代码 提交 忽略-target 忽略target的方法： 第一步，右键打开git bash 第二步，执行命令：touch .gitignore 第三步，将需要忽略的target写入.gitignore中 二、mybatisPlus入门 1.简介 MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错 支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多种数据库 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题 支持 XML 热加载：Mapper 对应的

1.打开程序包管理控制台输入: Install-Package Swashbuckle 2.打开App_Start文件夹下的SwaggerConfig.cs文件找到 c.IncludeXmlComments 替换为 c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name)); 3.添加方法 protected static string GetXmlCommentsPath(string name) { return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name); } 4.右键项目->属性->生成->勾选（XML文档文件）->保存 5.访问地址 http://localhost:15416/swagger/ui/index 如下图： 官方地址: Swagger 来源： https://www.cnblogs.com/zevfang/p/6398382.html