SpringBoot 显示Swagger Api 文档

1. 配置pom文件,在pom文件中引入Swagger的相关依赖:

<!-- swagger -->
<dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.9.3</version>
</dependency><dependency><groupId>com.spring4all</groupId><artifactId>swagger-spring-boot-starter</artifactId><version>1.9.0.RELEASE</version>
</dependency>

2.在application.yml 文件中配置相关 swagger 参数

2-1. 配置说明--默认配置：

swagger.enabled=是否启用swagger，默认：true
swagger.title=标题
swagger.description=描述
swagger.version=版本
swagger.license=许可证
swagger.licenseUrl=许可证URL
swagger.termsOfServiceUrl=服务条款URL
swagger.contact.name=维护人
swagger.contact.url=维护人URL
swagger.contact.email=维护人email
swagger.base-package=swagger扫描的基础包，默认：全扫描
swagger.base-path=需要处理的基础URL规则，默认：/**
swagger.exclude-path=需要排除的URL规则，默认：空
swagger.host=文档的host信息，默认：空

2-2. Authorization 鉴权配置

# 鉴权策略ID，对应 SecurityReferences ID
swagger.authorization.name=Authorization# 鉴权策略，可选 ApiKey | BasicAuth | None，默认ApiKey
swagger.authorization.type=ApiKey# 鉴权传递的Header参数
swagger.authorization.key-name=token# 鉴权传递的Header参数名称
swagger.authorization.name=token# 需要开启鉴权URL的正则, 默认^.*$匹配所有URL
swagger.authorization.auth-regex=^.*$

说明：其他具体的参数配置：https://github.com/SpringForAll/spring-boot-starter-swagger

3.在项目启动入口添加注解 @EnableSwagger2Doc

import com.spring4all.swagger.EnableSwagger2Doc;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@EnableSwagger2Doc
@SpringBootApplication
public class DemoApplication {public static void main(String[] args) {SpringApplication.run(DemoApplication.class, args);}}

4.启动项目访问地址：http://localhost:8005/doc.html，内容如下：

swagger demo地址：https://github.com/abbottyf/swagger

SpringBoot 显示Swagger Api 文档相关推荐

swagger api文档_带有Swagger的Spring Rest API –公开文档
swagger api文档创建API文档后,将其提供给涉众很重要. 在理想情况下,此发布的文档将足够灵活以解决任何最后的更改,并且易于分发(就成本以及完成此操作所需的时间而言). 为了使之成为可能, ...
swagger 扫描java文档_推荐一款在运行时通过javadoc生成Swagger API文档的库
介绍一般,我们使用Springfox生成swagger api文档,但Springfox不支持从javadoc中生成,只能通过注解的方式标注文档. 这样,当共享一些POJO类时,为了同时生成java ...
swagger api文档_带有Swagger的Spring Rest API –创建文档
swagger api文档使REST API易于使用的真正关键是好的文档. 但是,即使您的文档做得很好,您也需要设置公司流程的权利以正确,及时地发布它. 确保利益相关者按时收到是一回事,但是您也要负 ...
SpringBoot 自动生成API文档
SpringBoot 自动生成API文档在做项目的时候,如果项目是前后分离的,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Excel或者Word来写, ...
java文档注释生产api没有注释_一个神奇的没有springboot注释的api文档生成器---JApiDocs...
入门支持JDK:1.8+ 快速开始第一步:添加依赖 maven: io.github.yedaxia japidocs 1.4.3 gradle: compile 'io.github.yedax ...
Oh my God, Swagger API文档竟然可以这样写？
最好的总会在不经意间出现. " 作为后端程序员,免不了与前端同事对接API, 一个书写良好的API设计文档可有效提高与前端对接的效率. 为避免联调时来回撕逼,今天我们聊一聊正确编写Swaag ...
springboot api文档_SpringCloud/SpringBoot - 自动生成API文档
SpringCloud/SpringBoot 的项目一定要前后分离,这就需要一个API文档生成的工具,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Exc ...
聚合微服务中的 Swagger API 文档
没有做 API 文档聚合,访问每个服务的 API 文档都需要访问单独的 swagger-ui.html 页面,既然我们使用了微服务,就应该有统一的 API 文档入口,而 knife4j 有这方面的支持 ...
SpringBoot整合knif4j Api文档
文章目录前言一.maven 依赖二.配置三.遇到问题 1.ignoredParameterTypes 2.访问 doc.html 404 前言 knife4j是为Java MVC框架集成Swa ...

SpringBoot 显示Swagger Api 文档

1. 配置pom文件,在pom文件中引入Swagger的相关依赖:

2.在application.yml 文件中配置相关 swagger 参数

2-1. 配置说明--默认配置：

2-2. Authorization 鉴权配置

3.在项目启动入口添加注解 @EnableSwagger2Doc

4.启动项目访问地址：http://localhost:8005/doc.html，内容如下：

swagger demo地址：https://github.com/abbottyf/swagger

SpringBoot 显示Swagger Api 文档相关推荐

最新文章

热门文章

SpringBoot 显示Swagger Api 文档

1. 配置pom文件,在pom文件中引入Swagger的相关依赖:

2.在application.yml 文件中配置相关 swagger 参数

2-1. 配置说明--默认配置：

2-2. Authorization 鉴权配置

3.在项目启动入口添加注解 @EnableSwagger2Doc

4.启动项目访问地址 ：http://localhost:8005/doc.html，内容如下：

swagger demo地址：https://github.com/abbottyf/swagger

SpringBoot 显示Swagger Api 文档相关推荐

最新文章

热门文章

4.启动项目访问地址：http://localhost:8005/doc.html，内容如下：