swagger

前言 前两天逛jfinal社区，看到 jfinal-swagger 项目，接触到swagger，研究了一番对部分代码进行修改，成功整合到LMS，支持jfinal 多模块扫描，去除冗余依赖，修改try it out 问题等 。 具体代码使用请见LMS 。 Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。 Swagger 让部署管理和使用功能强大的API从未如此简单。 配置方法 下载jfinal-swagger到本地，具体问题修改参考 LMS的common 模块，然后mvn clean install。 <dependency> <groupId>com.feizhou</groupId> <artifactId>jfinal-swagger</artifactId> <version>1.0-SNAPSHOT</version> </dependency> 2.下载你喜欢的 swagger-ui组件包： https://github.com/swagger-api/swagger-ui 将资源文件放入到webapp下，（不要求路径和我一致作参考），** 注意修改 index.html

问题描述：刚配置好了swagger，沿用netcore2.2的配置继续在浏览器打开api控制器，结果报错了。。。 解决方法：从路由层面查找了半天原因，无果，最后把api页面中的跨域设置去掉后正常了，看来和跨越设置有关，继续查找，原来是注册时候顺序导致的问题 // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { app.UseStaticFiles(); app.UseCookiePolicy(); app.UseRouting(); //允许跨域 位置和必须放对，否则加载出错 app.UseCors("any"); app.UseEndpoints(endpoints => endpoints.MapDefaultControllerRoute()); //启用中间件服务生成Swagger作为JSON终结点 app.UseSwagger(); //启用中间件服务对swagger-ui，指定Swagger JSON终结点 app.UseSwaggerUI(c => { c

什么是注解 注解(Annotation) 相当于一种标记，在程序中加入注解就等于为程序打上某种标记，就去干相应的事，标记可以加在包、类，属性、方法，方法的参数以及局部变量上。 注解的简单应用 注解类 @interface A { } 应用注解类 @A class B { @A String field; @A void method(){ } } 小结 注解可以加在类、成员变量、成员方法上。 注解是JDK1.5之后才提供的特性，三个常见注解： @Deprecated 意思是“废弃的，过时的” @Override 意思是“重写、覆盖” @SuppressWarnings 意思是“压缩警告” 元注解 首先解释一下什么是元注解，元注解就是注解注解的注解。 说起来有点拗口，可以这样理解，看下面的例子： /** * 这是一个自定义的注解(Annotation)类 在定义注解(Annotation)类时使用了另一个注解类Retention * 在注解类上使用另一个注解类，那么被使用的注解类就称为元注解 */ @Retention(RetentionPolicy.RUNTIME) @Target({ ElementType.METHOD, ElementType.TYPE }) public @interface MyAnnotation { } 这是我们自定义的注解 MyAnnotation

如何生成swagger-ui需要的json或者yaml的文件? tp5根目录, composer require zircote/swagger-php 方案1： 有需要的时候手动执行命令生成api_doc.json文件 添加命令 application/command.php 新增一行： \app\common\command\run\AutoCreateApiDoc::class , 就可以执行 php think run:autoCreateApiDoc 手动生成swagger json配置文件, 配置文件所在路径 public/api_doc.json /** * Created by querying. * Date: 19-2-20 * Time: 下午5:15 */ namespace app\common\command\run; use function \OpenApi\scan; use think\console\Command; use think\console\Input; use think\console\Output; use think\facade\App; class AutoCreateApiDoc extends Command { protected function configure() { $this->setName("run

错误描述：按照netcore2.X的配置，再次配置swagger后，/swagger/index.html打不开。。。 解决方案：在Startup.cs 文件中 Configure 方法里 //允许跨域 app.UseCors("any"); //启用中间件服务生成Swagger作为JSON终结点 app.UseSwagger(); //启用中间件服务对swagger-ui，指定Swagger JSON终结点 app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); c.RoutePrefix = string.Empty; }); 把标黄色背景的这段去掉了就可以了。或者改为特定的路由，替换默认的 swagger，如 c.RoutePrefix = "doc"; 则swagger的访问地址变为"/doc/index.html" 参考地址： https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-3.1&tabs=visual-studio 要在应用的根 (http://localhost:<port>/) 处提供

使用第三方提供的swgger ui 可有效提高 web api 接口列表的阅读性。而且能够在页面中測试服务接口。 但本人在查阅大量资料并进行编码測试后，发现大部分的swagger实例并不能有效执行。比如例如以下两个网址：http://www.cnblogs.com/caodaiming/p/4156476.html 和 http://bitoftech.net/2014/08/25/asp-net-web-api-documentation-using-swagger/。 经过本人的一番折腾，终于发现，原来是由版本号的差异导致的（以上两个样例在4.2.0版本号下执行成功。读者可自行測试）。哎，要是这些作者可以标出插件包的版本号，真能省下非常多功夫。 眼下Swashbuckle的最新稳定版本号为 5.2.1版 。这个版本号的编码方式与4.2.0版本号有一定差异，本文也以5.2.1版本号为例进行说明。 注：本文使用OWIN来自寄宿（self-host） web api，不清楚的读者可參考：http://www.asp.net/web-api/overview/hosting-aspnet-web-api/use-owin-to-self-host-web-api。 1、新建一个控制台应用程序OwinConsoleApp。Nuget分别加入Swashbuckle（5.2.1版本号

上回咋们说了iot-pt的整套结构，接着咋们开始说web manage，web manage是iot-pt提供可视化操作的服务，但是笔者前端功底实在太弱，这里就不打算做页面了，就使用swagger了。 流程说明 用户在web端添加产品，持久化产品数据 根据产品添加属性信息，持久化属性数据，redis缓存属性数据 根据产品创建指令，持久化指令数据 根据产品创建事件，持久化事件数据 根据产品创建设备，持久化设备数据，redis缓存设备数据 结构图 项目搭建 使用idea搭建spring boot iot-pt项目，创建iot-manage模块，笔者这里的spring boot版本是2.1.4，引入swagger，mybatis，pgsql依赖。 构建基础iot-beans模块，用于公用实体类，公用工具类的编写 具体的搭建细节就不在笔者的说明范围之内了哈 模型搭建 这里先实现iot数据的上行，也就是设备上报的业务数据 产品模型 @ApiModel(value = "产品参数") public class ProductDTO { @ApiModelProperty(value = "产品名称") @NotBlank private String name; @ApiModelProperty(value = "设备型号") @NotBlank private String model;

springboot之swagger快速启动(新的ui) 功能点: 集成 swagger 前端接口文档 Swagger 整合 zuul 智能列表 无缝集成 knife4j 前端文档 支持 v0.1.2RELEASE zuul 智能列表 简介 在原有 swagger 功能之上集成 knife4j 。 knife4j 是 springfox-swagger 的增强UI实现，为Java开发者在使用Swagger的时候，能拥有一份简洁、强大的接口文档体验。 该UI增强包主要包括两大核心功能： 文档说明 和 在线调试 文档说明： 根据Swagger的规范说明，详细列出接口文档的说明，包括接口地址、类型、请求示例、请求参数、响应示例、响应参数、响应码等信息，使用swagger-bootstrap-ui能根据该文档说明，对该接口的使用情况一目了然。 在线调试： 提供在线接口联调的强大功能，自动解析当前接口参数,同时包含表单验证，调用参数可返回接口响应内容、headers、Curl请求命令实例、响应时间、响应状态码等信息，帮助开发者在线调试，而不必通过其他测试工具测试接口是否正确,简介、强大。 功能使用 添加依赖 <dependency> <groupId>io.deepblueai</groupId> <artifactId>swagger-deepblueai-starter<