JarCasting
JarCasting JarCasting

Swagger::Spring Boot::Starter

Easy to use swagger in spring boot project.

License

License
Categories

Categories

Net Swagger Program Interface REST Frameworks
GroupId

GroupId

net.ifok.swagger
ArtifactId

ArtifactId

swagger-boot-starter
Last Version

Last Version

2.10.2
Release Date

Release Date
Type

Type

jar
Description

Description

Swagger::Spring Boot::Starter
Easy to use swagger in spring boot project.
Project URL

Project URL

https://github.com/leftso/swagger-boot-starter
Source Code Management

Source Code Management

https://github.com/leftso/swagger-boot-starter.git

Download swagger-boot-starter

Filename Size
swagger-boot-starter-2.10.2.pom
swagger-boot-starter-2.10.2.jar 10 KB
swagger-boot-starter-2.10.2-sources.jar 5 KB
swagger-boot-starter-2.10.2-javadoc.jar 47 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/net.ifok.swagger/swagger-boot-starter/ -->
<dependency>
    <groupId>net.ifok.swagger</groupId>
    <artifactId>swagger-boot-starter</artifactId>
    <version>2.10.2</version>
</dependency>
// https://jarcasting.com/artifacts/net.ifok.swagger/swagger-boot-starter/
implementation 'net.ifok.swagger:swagger-boot-starter:2.10.2'
// https://jarcasting.com/artifacts/net.ifok.swagger/swagger-boot-starter/
implementation ("net.ifok.swagger:swagger-boot-starter:2.10.2")
'net.ifok.swagger:swagger-boot-starter:jar:2.10.2'
<dependency org="net.ifok.swagger" name="swagger-boot-starter" rev="2.10.2">
  <artifact name="swagger-boot-starter" type="jar" />
</dependency>
@Grapes(
@Grab(group='net.ifok.swagger', module='swagger-boot-starter', version='2.10.2')
)
libraryDependencies += "net.ifok.swagger" % "swagger-boot-starter" % "2.10.2"
[net.ifok.swagger/swagger-boot-starter "2.10.2"]

Dependencies

compile (4)

Group / Artifact Type Version
io.springfox : springfox-swagger2 jar 2.10.5
io.springfox : springfox-swagger-ui jar 2.10.5
io.springfox : springfox-spring-webmvc jar 2.10.5
org.springframework.boot : spring-boot-configuration-processor Optional jar 2.2.2.RELEASE

provided (2)

Group / Artifact Type Version
org.springframework.boot : spring-boot-autoconfigure jar 2.2.2.RELEASE
org.projectlombok : lombok jar 1.18.12

Project Modules

There are no modules declared in this project.

Swagger Spring Boot Stater

简介

spring boot 整合 springfox 实现swagger api文档生成。本项目主要简化整合流程，达到开箱即用，无需更多java代码配置。

使用说明

Spring Boot项目（兼容 2.2.0-2.4.0）

引入依赖

<dependency>
  <groupId>net.ifok.swagger</groupId>
  <artifactId>swagger-spring-boot-starter</artifactId>
  <version>1.2.1</version>
</dependency>

Spring Boot 介于2.0.0-2.20之间，引入方式

方法一：

    <properties>
        ...其他
        <spring-plugin.version>2.0.0.RELEASE</spring-plugin.version>
    </properties>

在pom.xml的properties节点添加<spring-plugin.version>2.0.0.RELEASE</spring-plugin.version> 然后引入

<dependency>
  <groupId>net.ifok.swagger</groupId>
  <artifactId>swagger-spring-boot-starter</artifactId>
  <version>1.2.2</version>
</dependency>

方法二：

<dependency>
  <groupId>net.ifok.swagger</groupId>
  <artifactId>swagger-spring-boot-starter</artifactId>
  <version>1.2.2</version>
  <exclusions>
      <exclusion>
          <groupId>org.springframework.plugin</groupId>
          <artifactId>spring-plugin-core</artifactId>
      </exclusion>
      <exclusion>
          <groupId>org.springframework.plugin</groupId>
          <artifactId>spring-plugin-metadata</artifactId>
      </exclusion>
  </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.plugin</groupId>
    <artifactId>spring-plugin-core</artifactId>
    <version>2.0.0.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework.plugin</groupId>
    <artifactId>spring-plugin-metadata</artifactId>
    <version>2.0.0.RELEASE</version>
</dependency>

Spring Boot 配置说明

单组配置

spring.swagger.url-pattern=/**
spring.swagger.packages=
spring.swagger.api-title=API开放文档
spring.swagger.api-description=Api 接口说明
spring.swagger.terms-of-service-url=
spring.swagger.contact.name=联系人名
spring.swagger.contact.email[email protected]
spring.swagger.contact.url=wwww.baidu.com
spring.swagger.license=Apache 2
spring.swagger.license-url=

提示: spring.swagger.config.packages 与 spring.swagger.config.url-pattern 可以只选择其中一个配置，如果两个同时配置则回取两个的并集。

多组别配置

#A组
spring.swagger.group.aaa.group-name=A组名称
spring.swagger.group.aaa.url-pattern=/aaa/**
spring.swagger.group.aaa.packages=
spring.swagger.group.aaa.api-title=A分组API
spring.swagger.group.aaa.api-description=A分组API主要用于干xxx
spring.swagger.group.aaa.terms-of-service-url=
spring.swagger.group.aaa.contact.name=联系人名
spring.swagger.group.aaa.contact.email[email protected]
spring.swagger.group.aaa.contact.url=wwww.baidu.com
spring.swagger.group.aaa.license=Apache 2
spring.swagger.group.aaa.license-url=
#B组
spring.swagger.group.bbb.group-name=B组名称
spring.swagger.group.bbb.url-pattern=/bbb/**
spring.swagger.group.bbb.packages=
spring.swagger.group.bbb.api-title=B分组API
spring.swagger.group.bbb.api-description=B分组API主要用于干xxx
spring.swagger.group.bbb.terms-of-service-url=
spring.swagger.group.bbb.contact.name=联系人名
spring.swagger.group.bbb.contact.email[email protected]
spring.swagger.group.bbb.contact.url=wwww.baidu.com
spring.swagger.group.bbb.license=Apache 2
spring.swagger.group.bbb.license-url=

注意：当同时配置了多分组和单分组，单分组将会无效！

Springfox相关注解使用说明

  • Spring 项目的controller类，添加@Api(tags="该controller的处理说明") 
    @Api(tags = "用户相关操作")
public class UserController {

    @ApiOperation("添加用户")
    public Object addUser(){
        return "success";
    }
}
  • Spring 项目的controller类，方法添加 @ApiOpertion("该接口说明")
  • 未完待续

更多参考

LICENSE

Apache Software License, Version 2.0

Versions

Version
2.10.2
2.10.1
2.10.0
2.9.3
2.9.2