Swagger-Spring-Boot 项目教程

Swagger-Spring-Boot 项目教程

swagger-spring-bootswagger-spring-boot-starter 是一款建立在swagger基础之上的工具包，利用SpringBoot自动装配的特性，简化了传统swagger的繁琐配置项目地址:https://gitcode.com/gh_mirrors/sw/swagger-spring-boot

1. 项目的目录结构及介绍

swagger-spring-boot/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── battcn/
│   │   │           └── swagger/
│   │   │               ├── config/
│   │   │               ├── controller/
│   │   │               ├── entity/
│   │   │               ├── service/
│   │   │               └── SwaggerSpringBootApplication.java
│   │   └── resources/
│   │       ├── application.properties
│   │       └── static/
│   └── test/
│       └── java/
│           └── com/
│               └── battcn/
│                   └── swagger/
│                       └── SwaggerSpringBootApplicationTests.java
├── pom.xml
└── README.md

目录结构介绍

• src/main/java/com/battcn/swagger/: 主要代码目录，包含配置、控制器、实体和服务等。
  • config/: 存放项目配置类。
  • controller/: 存放API控制器类。
  • entity/: 存放实体类。
  • service/: 存放服务类。
  • SwaggerSpringBootApplication.java: 项目启动类。
• src/main/resources/: 存放资源文件，如配置文件和静态资源。
  • application.properties: 项目配置文件。
  • static/: 存放静态资源文件。
• src/test/java/com/battcn/swagger/: 测试代码目录。
  • SwaggerSpringBootApplicationTests.java: 项目测试类。
• pom.xml: Maven项目配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

SwaggerSpringBootApplication.java

package com.battcn.swagger;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SwaggerSpringBootApplication {

    public static void main(String[] args) {
        SpringApplication.run(SwaggerSpringBootApplication.class, args);
    }
}

启动文件介绍

• SwaggerSpringBootApplication.java 是项目的启动类，使用 @SpringBootApplication 注解标记，表示这是一个Spring Boot应用程序。
• main 方法中调用 SpringApplication.run 方法启动应用程序。

3. 项目的配置文件介绍

application.properties

# 服务器端口
server.port=8080

# Swagger配置
springfox.documentation.swagger.v2.path=/v2/api-docs
swagger.title=Swagger Spring Boot
swagger.description=Swagger Spring Boot 项目
swagger.version=1.0
swagger.termsOfServiceUrl=http://swagger.io/terms/
swagger.contact.name=battcn
swagger.contact.url=http://www.battcn.com
swagger.contact.email=battcn@gmail.com
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html

配置文件介绍

• server.port: 设置服务器端口为8080。
• springfox.documentation.swagger.v2.path: 设置Swagger API文档的路径。
• swagger.title: 设置Swagger文档的标题。
• swagger.description: 设置Swagger文档的描述。
• swagger.version: 设置Swagger文档的版本。
• swagger.termsOfServiceUrl: 设置服务条款的URL。
• swagger.contact.name: 设置联系人名称。
• swagger.contact.url: 设置联系人URL。
• swagger.contact.email: 设置联系人邮箱。
• swagger.license: 设置许可证名称。
• swagger.licenseUrl: 设置许可证URL。

以上是 swagger-spring-boot 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

swagger-spring-bootswagger-spring-boot-starter 是一款建立在swagger基础之上的工具包，利用SpringBoot自动装配的特性，简化了传统swagger的繁琐配置项目地址:https://gitcode.com/gh_mirrors/sw/swagger-spring-boot