Swagger UI

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>> 版本要求：jdk1.8以上 框架版本介绍：springboot 2.x mybatis-plus 3.x Maven 3.x以上 辅助工具介绍：lombok 简化代码 Swagger-bootstrap-ui 生成接口文档 Yml文件 注意：1、springboot1.x与2.x版本改动较大，具体请阅看官方文档。 官方地址： https://spring.io/projects/spring-boot/ 2、mybatis-plus 3.x与2.x 版本改动较大，具体请查阅官方文档。 官网地址： https://mp.baomidou.com/ 解释说明： springboot优点在于简化配置，全家桶自动集成优秀框架，基于注解开发。 综上所有优点，我们选择了lombok,与mybatis-plus ，还有swagger-ui。这三个都是基于注解使用。我认为选择其他的感觉优点鸡肋。 pom.xml文件 <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.2.0.RELEASE</version> <relativePath/> <!--

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>> skarl出现的原因? 解决前后端联调问题，后端已经有swagger但是没有做集成，比如www.a.com/user/swagger-ui.html与www.a.com/open/swagger-ui.html，N个工程接口有交互，需要同时开N浏览器页签查看，而且一旦有一个页面刷新输入的公参(比如:header)就悲剧的需要重新再输入一次了，应对一系列查看文档问题和文档更新不及时等，skarl出现了。 为什么叫skarl这个名字？ 暴怒骑士——克烈。说实话，第一次见到克烈骑的这个大眼愣的东西，真的不知道是个什么东西。相信现在也有很多的小伙伴叫不上它的名字吧。其实，它叫斯噶尔，是个蜥蜴。不过看起来就是有些怪。说起来，克烈在上路还是比较强势的英雄，因为有这个坐骑的存在，克烈总是多条命的 切入正题看一下skarl的主界面以及携带功能 依赖mongodb，当然对于使用swagger的团队来说mongodb当然属于小意思的维护级别。 比较懒 一些解释放到了图片中 一些基础设置，基于codemirror设置中自然也会有编辑区换肤功能 图标依次： 工作空间切换，在工作中尤其是夸部门或者夸团队所以需要很多工作空间。 ip刷新，skarl的权限不是根据任何其他组件 比如ladp 而是根据ip和mac地址

1. 概述 公司正好最近在整理项目的文档，且文档对于构建REST API来说是至关重要的。在这篇文章中，我将介绍 Spring Doc ， 一个基于 OpenAPI 3 规范简化了 Spring Boot 1.x 和 2.x 应用程序的API文档的生成和维护的工具。 2. 设置springdoc-openapi 如果想让 springdoc-openapi 为我们的API生成标准的 OpenAPI 3 文档, 只需要添加 [springdoc-openapi-core]( https://search.maven.org/search?q=g:org.springdoc AND a:springdoc-openapi-core&core=gav) 依赖到 pom.xml : <dependency> <groupid>org.springdoc</groupid> <artifactid>springdoc-openapi-core</artifactid> <version>1.1.45</version> </dependency> 添加完成后，启动应用程序，即可访问默认路径 /v3/api-docs 查看文档，如下所示： http://localhost:8080/v3/api-docs/ 如果想要自定义路径，可在 application.properties 文件中指定 :

准备环境 一个web服务器(我使用的是tomcat、当然nginx都可以) eclipse开发环境使用SpringMvc框架的源码(我使用springfox官网提供的demo) 下载swagger-ui源码 实现目的 eclipse中启动后台项目(也可以直接打包war在另一个tomcat中发布) web服务器使用swagger-ui做为前端展示层展示后台基于swagger暴露的接口 后台服务支持跨域请求(项目上线可以关闭) 1. 后台接口演示环境搭建 1.1 项目pom文件对依赖包引用如下： <properties> <jackson2.version>2.5.1</jackson2.version> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <spring.version>4.2.6.RELEASE</spring.version> <!-- swagger --> <swagger.version>2.6.1</swagger.version> </properties> <dependencies> <!-- servlet Start --> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet

背景 对外开放的接口，需要清晰的接口文档，方便客户端进行测试，目前restful风格的接口定义是最好理解，调用和测试的接口风格；服务提供端也需要一种简单的办法，把已有的服务接口发布为restful风格，代码注释即可作为接口文档，是服务端程序员可接受的方式，快捷，方便。 解决方案 首先选择restful风格的web接口，而不是soap或者wsdl风格的web服务接口，优点很多，java6已经把jax-rs作为标准的一部分。 dubbo作为一种十分流行和强大的微服务框架，支持rest风格的rpc协议，dubbo官方框架2.6.0版本整合了dubbox的rest协议代码，使用dubbo rest协议很方便把我们写的业务逻辑代码（spring bean风格的接口实现）发布成restful服务接口。 dubbo rest rpc协议基于easyrest实现restful rpc；easyrest是JAX-RS一种实现，目前是3.0.7版本，支持JAX-RS2，通过jcp认证。 Swagger是一种Openapi接口定义，文档化，展示，测试的解决方案，由swagger core, swagger annotation, swagger module, swagger ui, swagger editor等组件组成。目前是openapi最为完整解决方案。 项目如何整合 服务端工作

在 spring boot 项目中配置 Swagger2 突然出现了 404 报错, 究其原因,是因为 MVC 没有找到 swagger-ui 包中的 swagger-ui.html 文件; 以下就是 swagger2 的配置,及解决方案: 一, 引入Maven : <dependency> <!-- API --> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency> 二, 编写配置文件 : package com.gy.fast.common.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import io.swagger.annotations

已完成，todo 整理发布 1、已有的spring boot swagger ui-A项目 2、 https://github.com/JMCuixy/swagger2word 3、配置 swagger2word 项目的application.yml，指向项目A的Swagger Json资源的url地址 swagger.url: http://192.168.56.1:8080/renren-fast/v2/api-docs 4、启动 swagger2word 项目，访问 http://127.0.0.1:8080/toWord ，右键另存为xx.doc文件即可 注意事项：此方法要求A项目利用swagger开发时写好了足够的传承和返回值注解，这样生成的接口文档内容才比较丰富。 来源： https://my.oschina.net/sunyouling/blog/3110222

导Jar包： <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency> Swagger-ui的配置类： @Configuration @EnableSwagger2 @EnableWebMvc public class WebMvcConfig implements WebMvcConfigurer { //这个方法不用动 @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("swagger-ui.html") .addResourceLocations("classpath:/META-INF/resources/"); registry

编者注 之前让其他写服务端的小伙伴支持swagger，然后最近一直在写Unity，没有把之前的项目和Swagger进行集成 Swagger Core Swagger Core Git Swagger 2.X 快速开始 注意：Swagger 2.x 遵循 OpenApi 3.0 定义的文件。如果你期望使用1.5.x版本的Swagger或者OpenApi 2.0，请参考 1.5.X JAX-RS Setup SpringBoot与Swagger2 Gradle dependencies { // 原生UI //compile("io.springfox:springfox-swagger-ui:2.9.2") // 国内人编写的左右分隔的UI compile("com.github.xiaoymin:swagger-bootstrap-ui:1.8.9") compile("io.springfox:springfox-swagger2:2.9.2") //... } 配置 由于springboot需要手动编写配置Bean，则代码如下 @Configuration @EnableSwagger2 public class SwaggerConfiguration { @Bean public Docket createRestApi(){ return new Docket

首先需要引入几个maven依赖，pom.xml如下 <!-- swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.5.0</version> </dependency> <!-- swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.5.0</version> </dependency> <dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>28.0-jre</version> </dependency> 配置config @EnableSwagger2 @Configuration public class SwaggerConfig { @Bean public Docket swaggerSpringMvcPlugin() { return new Docket(DocumentationType