Swagger UI

认识Swagger Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。 作用： 接口的文档在线自动生成。 功能测试。 为什么使用Swagger作为REST APIs文档生成工具 Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。 Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。 Swagger 文件可以在许多不同的平台上从代码注释中自动生成。 Swagger 有一个强大的社区，里面有许多强悍的贡献者。 安装Nuget包搜索Swashbuckle.AspNetCore 因为是.NetCore3.0 ,所以一定要勾选包括预览发行版，安装最新预发行版 5.0.0-rc4,千万不要安装最新稳定版。稳定版会报错。 稳定版报错信息： 1 Some services are not able to be constructed (Error while validating the service descriptor ' ServiceType: 2 Swashbuckle.AspNetCore.Swagger.ISwaggerProvider

问题 springcloud 版本 为 Finchley.RELEASE springboot 版本为 2.0.3.RELEASE 现在有需求，/swagger-ui.html 页面需要添加登录认证，但是本来的接口不需要登录认证 升级springboot之前的做法是直接在application.yml 文件中添加以下配置： security: basic: enabled: true # 启用SpringSecurity的安全配置项 path: /swagger-ui.html user: name: aijianzi # 认证用户名 password: course # 认证密码 role: # 授权角色 - USER 升级后这种配置就出错了，连编译都出错，如下图： 解决过程 查找源代码，找到如下： 来自： https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.0-Migration-Guide Security Spring Boot 2 greatly simplifies the default security configuration and makes adding custom security easy. Rather than having several security

　　在总结完整个ABP项目的结构之后，我们就来看一看ABP中这些主要的模块是按照怎样的顺序进行加载的，在加载的过程中我们会一步步分析源代码来进行解释，从而使自己对于整个框架有一个清晰的脉络，在整个Asp.Net Core项目中，我们启动一个带Swagger UI的Web API项目为例，在介绍这个Web API项目之前我们先来看看整个Swagger 文档的样式。 　　我们定义的WebAPI最终都会以Swagger文档这种形式来展现出来，通过这种形式也是非常方便我们进行代码的调试的，在进行网站的前后端分离开发的过程中，前端去定义接口后端根据前端定义的接口进行开发，这个模式能够实现整个开发的分离，当然这篇文章主要不是介绍如何去进行前后端分离开发而是重点介绍如何ABP模块中代码的加载顺序，前面的截图是整个ABP项目的启动界面，通过这些能够让我们对整个项目有一个概念性的认识和理解。 　　在整个项目的运行过程中，首先也是从Program类中开始的，首先执行Program类中的静态Main方法，然后在Main方法中会创建一个IWebHost对象，然后执行Run方法，看起来像下面的形式： public class Program { private static IConfiguration Configuration { get; set; } public static void Main

##0.引言及注意事项 Swagger是一个接口文档工具，依照Swagger可以0配置开发接口。不过要注意，Swagger是基于SpringBoot1.47版本开发的，而SpringBoot现在基本都是是2+。 如果要选用restful支持，只能将SpringBoot退出到1+版本。 ##1.maven引入 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> ##2.Swagger配置文档 import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder;

虽然每天的工作都是CURD、还是使用着传统的三层架构、使用着.net Framework，但是这并不能影响我学习DDD和.net core。 总是希望软件在应对复杂多变的场景时能够游刃有余，在解决问题时能够多一种选择。 很早就有关注大神 dax.net 的 NLayerApp 系列博文 https://www.cnblogs.com/daxnet/category/304141.html 近期入坑.net core，看了 进击的辣条 的文章 Asp.Net Core微服务初体验 ，很有收获，感谢感谢。 抽时间读了下NLayerAppV3项目的源码，Github地址： https://github.com/cesarcastrocuba/nlayerappv3 分享下体会，希望相互交流学习，谢谢！ 1、项目简介 NLayerAppV3是一个使用.net 2.1实现的经典DDD的分层架构的项目。 NLayerAppV3是在NLayerAppV2的基础上，使用.net core2.1进行重新构建的；它包含了开发人员和架构师都可以重用的DDD层；以银行和博客上下文示例。 2、项目结构 放一张DDD风格架构l图。主要分为四层：表现层、应用层、领域层和基础结构层。 详细的各层的含义可以查看 dax.net 的文章 https://www.cnblogs.com/daxnet/archive

在前面随笔介绍ABP应用框架的项目组织情况，以及项目中领域层各个类代码组织，以及简化了ABP框架的各个层的内容，使得我们项目结构更加清晰。上篇随笔已经介绍了字典模块中应用服务层接口的实现情况，并且通过运行Web API的宿主程序，可以在界面上进行接口测试了，本篇随笔基于前面介绍的基础上，介绍Web API调用类的封装和使用，使用包括控制台和Winform中对调用封装类的使用。 在上篇随笔《 ABP开发框架前后端开发系列---（3）框架的分层和文件组织 》中我绘制了改进后的ABP框架的架构图示，如下图所示。 这个项目分层里面的 03-Application.Common 应用服务通用层，我们主要放置在各个模块里面公用的DTO和应用服务接口类。有了这些DTO文件和接口类，我们就不用在客户端（如Winform客户、控制台、WPF/UWP等）重复编写这部分的内容，直接使用即可。 这些DTO文件和接口类文件，我们的主要用途是用来封装客户端调用Web API的调用类，使得我们在界面使用的时候，调用更加方便。 1）Web API调用类封装 为了更方便在控制台客户端、Winform客户端等场景下调用Web API的功能，我们需要对应用服务层抛出的Web API接口进行封装，然后结合DTO类实现一个标准的接口实现。 由于这些调用类可能在多个客户端中进行共享，因此根据我们在混合框架中积累的经验

http://127.0.0.1:18000/swagger-ui.html# 来源： oschina 链接： https://my.oschina.net/qwfys200/blog/3270362

【推荐阅读】微服务还能火多久？>>> 1.什么是Swagger/OpenAPI？ Swagger是一个与语言无关的规范，用于描述REST API。因为Swagger项目已捐赠给OpenAPI计划，所以也叫OpenAPI。它允许计算机和人员了解服务的功能，可以直接在线访问测试API功能。而Swagger UI提供了基于Web的UI，它使用生成的Swagger规范提供有关服务API的信息。Swashbuckle和NSwag均包含Swagger UI的嵌入式版本，因此可使用中间件注册调用将该嵌入式版本托管在ASP.NET Core应用程序当中。Swagger的核心是Swagger规范，默认情况下是名为swagger.json的文档。它由Swagger工具链（或其第三方实现）根据你的服务生成。它描述了API的功能以及使用HTTP对其进行访问的方式。它驱动Swagger UI，并由工具链用来启用发现和客户端代码生成。 2.NET Swagger实现 NET Swagger实现分为两大分类： ● Swashbuckle.AspNetCore是一个开源项目，用于生成ASP.NET Core Web API的Swagger文档。 ● NSwag是另一个用于生成Swagger文档并将Swagger UI或ReDoc集成到ASP.NET Core Web API中的开源项目。此外，NSwag

【今日推荐】：为什么一到面试就懵逼！>>> 1.什么是Swagger/OpenAPI？ Swagger是一个与语言无关的规范，用于描述REST API。因为Swagger项目已捐赠给OpenAPI计划，所以也叫OpenAPI。它允许计算机和人员了解服务的功能，可以直接在线访问测试API功能。而Swagger UI提供了基于Web的UI，它使用生成的Swagger规范提供有关服务API的信息。Swashbuckle和NSwag均包含Swagger UI的嵌入式版本，因此可使用中间件注册调用将该嵌入式版本托管在ASP.NET Core应用程序当中。Swagger的核心是Swagger规范，默认情况下是名为swagger.json的文档。它由Swagger工具链（或其第三方实现）根据你的服务生成。它描述了API的功能以及使用HTTP对其进行访问的方式。它驱动Swagger UI，并由工具链用来启用发现和客户端代码生成。 2.NET Swagger实现 NET Swagger实现分为两大分类： ● Swashbuckle.AspNetCore是一个开源项目，用于生成ASP.NET Core Web API的Swagger文档。 ● NSwag是另一个用于生成Swagger文档并将Swagger UI或ReDoc集成到ASP.NET Core Web API中的开源项目。此外，NSwag

【今日推荐】：为什么一到面试就懵逼！>>> spring-boot-plus是易于使用，快速，高效，功能丰富，开源的spring boot脚手架 前后端分离,专注于后端服务 目标 每个人都可以独立、快速、高效地开发项目！ GITHUB | GITEE 官网 springboot.plus V2.0 视频介绍 主要特性 集成spring boot 常用开发组件集、公共配置、AOP日志等 Maven多模块架构 集成mybatis plus快速dao操作 快速生成后台代码: entity/param/vo/controller/service/mapper/xml 集成Swagger/Knife4j，可自动生成api文档 集成jwt、shiro权限控制 集成Redis缓存 集成HikariCP连接池，JDBC性能和慢查询检测 集成spring boot admin，实时检测项目运行情况 使用assembly maven插件进行不同环境打包部署,包含启动、重启命令，配置文件提取到外部config目录 项目结构 └── spring-boot-plus ├── admin SpringBootAdmin Server模块 ├── bootstrap spring-boot-plus 启动模块 ├── config 配置模块 ├── distribution 打包模块 ├── docs