在 spring-boot 中使用 swagger SwaggerSpringBootStarter

Apache-2.0
Java 查看源码»
跨平台
2017-07-21
阿信sxq

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

使用时的项目配置

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

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

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

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

swagger.api.name = #api 的组信息
swagger.api.title = #标题
swagger.api.description = #描述信息
swagger.api.version = #版本
swagger.api.contactUser = #联系人名称
swagger.api.contactUrl = #联系人url
swagger.api.contactEmail = #联系人邮箱

swagger ui在使用时的配置

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

需要单独准备swagger ui

可以使用maven坐标为

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

的webjar

使用演示

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

使用演示可以查看 https://git.oschina.net/songxinqiang/SpringBootSwaggerStarter-Demo

加载中

评论(1)

SpringBootSwaggerStarter 2.0.5 发布,补充 UI 文件

SpringBootSwaggerStarter,用于简化在spring boot的web项目中使用swagger展示api的操作,依据spring boot官方的命名建议,在maven中使用“swagger-spring-boot-starter”的坐标。 此次升级,...

09/17 14:05

没有更多内容

加载失败,请刷新页面

没有更多内容

暂无问答

创建自己的Spring Boot starter

创建自己的Spring Boot starter

2017/10/25 11:01
40
0
Spring Cloud Zuul中使用Swagger汇总API接口文档

> 有很多读者问过这样的一个问题:虽然使用Swagger可以为Spring MVC编写的接口生成了API文档,但是在微服务化之后,这些API文档都离散在各个微服务中,是否有办法将这些接口都整合到一个文档...

05/25 08:43
873
0
Spring boot的Gradle配置

问题 最近尝试把自己现有的Maven工程转到Gradle工程上面来。 build.gradle buildscript { ext { springBootVersion = "2.1.0.RELEASE" } repositories { mavenCentral() } d......

11/02 10:18
17
0
精通Spring Boot——第九篇:整合Swagger在线文档

开发中最烦的一件事是什么?当你全心全意思考的时候,前端笑眯眯的过来了:“大哥,你没告诉我该传什么参数!”......然后一堆吧啦吧啦扯淡,好了,前端大佬心满意足的走了,你以为事情也就这...

10/14 21:44
37
1
Nexus(私有maven仓库)安装文档

依赖jdk,先安装jdk1.7 下载nexus mkdir /usr/local/nexus wget https://sonatype-download.global.ssl.fastly.net/nexus/oss/nexus-2.11.2-03-bundle.tar.gz tar -zxvf nexus-2.11.2-03-bun...

2017/12/05 18:50
15
0
spring cloud 相关的技术网站

spring cloud 版本选择:http://projects.spring.io/spring-cloud/ spring cloud 官方文档:http://projects.spring.io/spring-cloud/ spring cloud 中文文档:https://springcloud.cc/ ===...

02/06 15:18
40
0
Spring Boot开发问题汇总(不断更新中)

1、日志配置 LOG4J 2 CONFIGURATION: USING PROPERTIES FILE Spring Boot Logging Example Log4j Conversion Pattern Online Tester Log4j打印日志到不同的文件 Log4j2 过滤指定级别的日志 ...

05/28 10:14
61
0
2018年,新一期Spring Boot 面试题

问题一 什么是Spring Boot? 多年来,随着新功能的增加,spring变得越来越复杂。只需访问https://spring.io/projects页面,我们就会看到可以在我们的应用程序中使用的所有Spring项目的不同功...

08/14 14:18
7
0
Spring Boot中使用Swagger2构建RESTful API文档

随着前后端的分离,借口文档变的尤其重要,今天我们来说一说用SWAGGER2,来风骚的生成api文档。配置很简单,废话少说,直接上代码: build.gradle ``` dependencies { compile('org.springf...

2016/12/02 18:52
364
1

没有更多内容

加载失败,请刷新页面

返回顶部
顶部