com.github.sophisticatedxie:swagger2-plus-spring-boot-starter

Parent pom providing dependency and plugin management for applications built with Maven

License	License The Apache Software License, Version 2.0
Categories	Categories Spring Boot Container Microservices Swagger Program Interface REST Frameworks
GroupId	GroupId com.github.sophisticatedxie
ArtifactId	ArtifactId swagger2-plus-spring-boot-starter
Last Version	Last Version 1.0.0.RELEASE
Release Date	Release Date Nov 17, 2020
Type	Type jar
Description	Description Parent pom providing dependency and plugin management for applications built with Maven
Project Organization	Project Organization Pivotal Software, Inc.
Source Code Management	Source Code Management https://github.com/sophisticatedxie/swagger2-plus-spring-boot-starter.git

Download swagger2-plus-spring-boot-starter

Filename	Size
swagger2-plus-spring-boot-starter-1.0.0.RELEASE.pom
swagger2-plus-spring-boot-starter-1.0.0.RELEASE.jar	3 MB
swagger2-plus-spring-boot-starter-1.0.0.RELEASE-sources.jar	3 MB
swagger2-plus-spring-boot-starter-1.0.0.RELEASE-javadoc.jar	64 KB
Browse

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.sophisticatedxie/swagger2-plus-spring-boot-starter/ -->
<dependency>
    <groupId>com.github.sophisticatedxie</groupId>
    <artifactId>swagger2-plus-spring-boot-starter</artifactId>
    <version>1.0.0.RELEASE</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.sophisticatedxie/swagger2-plus-spring-boot-starter/
implementation 'com.github.sophisticatedxie:swagger2-plus-spring-boot-starter:1.0.0.RELEASE'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.sophisticatedxie/swagger2-plus-spring-boot-starter/
implementation ("com.github.sophisticatedxie:swagger2-plus-spring-boot-starter:1.0.0.RELEASE")

Apache Buildr

'com.github.sophisticatedxie:swagger2-plus-spring-boot-starter:jar:1.0.0.RELEASE'

Apache Ivy

<dependency org="com.github.sophisticatedxie" name="swagger2-plus-spring-boot-starter" rev="1.0.0.RELEASE">
  <artifact name="swagger2-plus-spring-boot-starter" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.sophisticatedxie', module='swagger2-plus-spring-boot-starter', version='1.0.0.RELEASE')
)

Scala SBT

libraryDependencies += "com.github.sophisticatedxie" % "swagger2-plus-spring-boot-starter" % "1.0.0.RELEASE"

Leiningen

[com.github.sophisticatedxie/swagger2-plus-spring-boot-starter "1.0.0.RELEASE"]

Dependencies

compile (9)

Group / Artifact	Type	Version
io.springfox : springfox-swagger2	jar	2.9.2
com.github.xiaoymin : swagger-bootstrap-ui	jar	1.9.6
org.springframework.boot : spring-boot-configuration-processor Optional	jar	2.3.1.RELEASE
org.springframework.boot : spring-boot-starter Optional	jar	2.3.1.RELEASE
com.alibaba : fastjson Optional	jar	1.2.38
org.projectlombok : lombok Optional	jar	1.16.10
org.springframework.boot : spring-boot-starter-web Optional	jar	2.3.1.RELEASE
org.springframework.boot : spring-boot-starter-actuator Optional	jar	2.3.1.RELEASE
com.google.guava : guava	jar	26.0-jre

test (1)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter-test	jar	2.3.1.RELEASE

Project Modules

There are no modules declared in this project.

swagger2-plus-spring-boot-starter

一、开发前阅读

更新日志

v1.0.1(时间: 2020-11-17)

##新特性

1.支持springboot多环境启用swagger

2.解决无group导致原先接口rest接口请求报错

3.更换了UI界面，更为简洁美观

v1.0.0(时间: 2020-5-10)

新特性

1.初代swagger自动装配

2.注解和配置文件双方式

1.涉及技术

springboot

swagger2

knife4j

vue

2.安装使用

2.1 前往maven repo maven中央仓库搜索 sophisticatedxie

maven玩家的pom写法:

<dependency>
  <groupId>com.github.sophisticatedxie</groupId>
  <artifactId>swagger2-plus-spring-boot-starter</artifactId>
  <version>1.0.0.RELEASE</version>
</dependency>

重新导入依赖即可。

gradle 玩家写法如下自行在仓库搜索对应写法。

3.涉及包结构

 |-swagger2-plus-spring-boot-starter                   
	|-com.github.sophisticatedxie      权限模块
	 |-annotations  启动注解 
         |-autoconfig  自动装配
         |-swagger      配置类

4.已完成/待完成

4.1 已完成

任务	完成时间	存在缺陷
基本框架搭建	2020/4/3	无
swagger2初代starter	2020/5/3	无
使用knife4j增强UI	2020/6/3	无
支持springboot多环境	2020/11/17	无
支持微服务多分组	2020/11/17	无

4.2 未完成

任务	预计开始	预计完成
国际化
移动端自适应UI

5.使用说明

5.1 主应用类注解

springboot主应用启动类上加上注解@EnableApiDocument,配上关于你项目的信息即可，如下:

@SpringBootApplication
@EnableApiDocument(title = "后台管理系统api文档",description = "swagger2-plus",groupName = "front",version = "1.0",profiles={"dev","test"})
public class SecurityApplication {
    public static void main(String[] args){
        SpringApplication.run(SecurityApplication.class,args);
    }

}

EnableApiDocument几个参数说明:

active: 布尔值 true 开启swagger false 不开启

title：api文档标题

description：文档描述

basePackages：扫描包路径(不写默认从主应用启动类及其子孙包)

groupName:分组名称

version:版本号

termsOfServiceUrl：项目生产环境或者实际地址

profiles：字符串数组,如{"dev","test"},则只有当你的springboot应用为dev或者test环境时才会开启api文档

5.2 效果展示

Versions

Version
1.0.0.RELEASE Nov 17, 2020

com.github.sophisticatedxie:swagger2-plus-spring-boot-starter

License

Categories

GroupId

ArtifactId

Last Version

Release Date

Type

Description

Project Organization

Source Code Management