当前位置: 首页 > 软件库 > 开发工具 > Java开发工具 >

SwaggerSpringBootStarter

在 spring-boot 中使用 swagger
授权协议 Apache-2.0
开发语言 Java HTML/CSS
所属分类 开发工具、 Java开发工具
软件类型 开源软件
地区 国产
投 递 者 尤茂材
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

在spring-boot中使用swagger,可以实现对代码无侵入地集成swagger

使用时的项目配置

需要在spring boot项目中使用,下面按照使用maven构建项目,以使用application.properties文件来配置进行介绍, 如果使用其他的构建工具或配置文件,做相应的变更即可

在maven配置文件pom.xml中添加依赖

<dependency>
    <groupId>cn.songxinqiang</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>2.1.1.RELEASE</version>
</dependency>

application.properties文件中配置api的信息

#配置swagger的api信息
swagger.api.name = demo-api
swagger.api.title=Demo API
swagger.api.description=SwaggerSpringBootStarter 使用样例,一切就是这么简单
swagger.api.version=2.1.1
swagger.api.contact.name = 阿信sxq
swagger.api.contact.email = xinqiang.song@zycoo.com
swagger.api.contact.url = https://my.oschina.net/songxinqiang/
swagger.api.exclude-paths=/error,/admin/**

其中忽略路径使用英文逗号进行分隔,可以不进行配置

swagger ui在使用时的配置

api的控制器会监听在地址/v2/api-docs?group=<swagger.api.name配置的值>, 对于swagger ui来说需要指定服务器的“基础地址”为项目的根地址即可

需要单独准备swagger ui

可以使用maven坐标为

<dependency>
    <groupId>cn.songxinqiang</groupId>
    <artifactId>swagger-spring-boot-starter-ui</artifactId>
    <version>2.1.1.RELEASE</version>
</dependency>

的webjar

使用演示

说明博客: https://my.oschina.net/songxinqiang/blog/1490463

使用演示可以查看 https://gitee.com/songxinqiang/SpringBootSwaggerStarter-Demo

 相关资料
  • 我使用Spring初始化器、嵌入式Tomcat、Thymeleaf模板引擎和作为可执行JAR文件的包生成了一个Spring Boot web应用程序。 使用的技术: 错误:

  • 这是我的代码: user.java UserController.java 结构: 提前谢谢

  • 我有Spring Boot应用程序(1.1.5.release),并通过配置protperty启用我的配置文件 概要文件被正确激活,我可以通过bean从创建的概要文件中看到这一点。 编辑二:那么有趣的部分来了: > 如果您在中定义了(默认情况下从类路径加载) 当您将文件重命名为并通过包含它时,它将停止工作。会引起一个虫子反对它。

  • 我有一个使用Spring Boot 2.0.0.RC2的项目。我需要使用Tomcat 7.0.82的传统部署将它部署到客户环境中。我已经成功构建了一个war,通过以Spring应用程序的典型方式(使用DispatcherServlet)配置< code>web.xml而不是使用< code > Spring bootservletinitializer ,可以成功部署该war。 我还想有一种使用嵌

  • 我想在crud项目中添加搜索字段,我使用的方法是 项目链接是:项目链接

  • 背景 我试图为我的spring boot data jpa应用程序创建一个自定义实现。 我的期望是spring boot-data-jpa将为我创建一个存储库bean,它结合了&中的所有优点,另外还将知道如何使用我的自定义实现存储库。 目前,我得到的只是 PropertyReferenceException:未找到属性getUsers