swagger增强版配置及输出接口文档

一、在pom.xml文件中添加相应依赖

（1）添加增强版swagger(Swagger Bootstrap UI) 的依赖，这里用的是1.9.6版本，可去maven的中央仓库中找最新版，附上连接https://mvnrepository.com/artifact/com.github.xiaoymin/swagger-bootstrap-ui

<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/swagger-bootstrap-ui -->
<dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.9.6</version>
</dependency>

(2)引入knife4j依赖（在Spring Boot单体架构下,knife4j提供了starter供开发者快速使用,该包会引用所有的knife4j提供的资源，包括前端Ui的jar包），这里用的是1.9.6版本。

<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-micro-spring-boot-starter</artifactId><version>1.9.6</version>
</dependency>

二、config配置

新建swagger配置类，命名为SwaggerConfig，配置如下：

package com.blank.practice.config;import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;/*** @author XXX* @version 1.0* @date 2020/1/10 15:48*/
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI  //第三方swagger增强API注解
public class SwaggerConfig {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).groupName("后台管理接口").apiInfo(apiInfo()).host("localhost:8080").select().apis(RequestHandlerSelectors.basePackage("com.blank.practice.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("practice项目API").description("swagger增强版练习项目").termsOfServiceUrl("").version("1.0").build();}}

三、测试

（1）新建一个TestController类进行测试

package com.blank.practice.controller;import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;/*** @author XXX* @version 1.0* @date 2020/1/10 15:13*/
@RestController
public class TestController {@GetMapping("/hello")public String getHello(){return "hello";}
}

（2）启动项目，浏览器访问 http://ip+port 或者域名 /doc.html，例如：http://localhost:8080/doc.html

（3）启用SwaggerBootstrapUi提供的增强功能

四、输出接口文档

（1）在文档管理中找到离线文档，在右边的接口目录中选择要输出文档的接口，拷贝文档

（2）把拷贝的内容粘贴到Typora中即可（下载Typora的地址为https://www.typora.io/）

最后从Typora中到处自己需要的文本格式即可

swagger增强版配置及输出接口文档相关推荐

使用swagger作为restful api的doc文档生成——从源码中去提取restful URL接口描述文档...
初衷记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情.也许多点,也许少点.甚至,接口总是需要适应新需求的,修改了,增加了,这份 ...
使用swagger作为restful api的doc文档生成
初衷记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情.也许多点,也许少点.甚至,接口总是需要适应新需求的,修改了,增加了,这份 ...
swagger api文档_带有Swagger的Spring Rest API –创建文档
swagger api文档使REST API易于使用的真正关键是好的文档. 但是,即使您的文档做得很好,您也需要设置公司流程的权利以正确,及时地发布它. 确保利益相关者按时收到是一回事,但是您也要负 ...
带有Swagger的Spring Rest API –创建文档
使REST API易于使用的真正关键是好的文档. 但是,即使您的文档做得不错,您也需要设置公司流程的权利,以正确,及时地发布它. 确保利益相关者按时收到是一回事,但是您也要负责API和文档中的更新. ...
信创操作系统--麒麟Kylin桌面版（项目六文档处理：输入法、WPS、文本编辑器）
信创操作系统–麒麟Kylin桌面版(项目六文档处理:输入法.WPS.文本编辑器) 目录 1. 输入法配置 2. WPS办公软件的使用 3. 编辑器 1. 输入法配置麒麟桌面版v10的输入法默认为搜 ...
swagger php 生成api,blog/Swagger生成php restful API接口文档.md at master · lfq618/blog · GitHub...
Swagger生成php restful API接口文档背景我们的restful api项目采用yaf框架, 整体结构简单, 我们只需要用swagger扫描 application目录即可. 下面 ...
Matlab R2018a版离线使用帮助文档方法
转载自:Matlab R2018a版离线使用帮助文档方法问题 Matlab R2018a版本安装后,帮助文档默认为在线方式,需要使用账号登录,如果没有激活密钥或许可证编号,就无法使用帮助文档了. 方 ...
Java游戏开发框架LGame-0 2 8版发布（含JavaSE及Android版，已有文档）
LGame是LoonFramework框架的一部分,也可简称做"LF"或"Loon". LGame框架的创立初衷在于,构建一个高效且完善的Java游戏开发体系, ...
Axure版PRD产品需求文档
Axure版PRD产品需求文档(教程+下载) vigo梓贤原型设计 10 人赞同了该文章今天给教大家用axure做一个产品需求文档(PRD)模板,其中包括目录,版本修订记录,产品概述,功能说明,全 ...