项目上的一点记录：git提交代码+swagger的运用

本文链接：https://blog.youkuaiyun.com/github_37228709/article/details/108006917

本文记录了在项目中如何使用git提交代码，并详细介绍了swagger在后端接口展示中的应用，包括添加依赖、配置文件、接口访问及返回参数解析，强调了swagger在前后端分离项目中的重要性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1.git提交代码

git命令每次都在用，但是每次都会忘，我想把git提交的命令写在开头，提醒自己不要忘了！！！！

# 虽然IDEA等都有快捷方式提交代码，但特殊情况下还是需要用命令行的方式提交代码
# 依次执行下面的命令
git status
git add *
git commit -m "更新说明"
# 下面的代码是从仓库拉去最新代码
git pull
# 合并分支并上传到仓库
git push origin master

2. swagger的运用：

swagger是用于后端接口展示给前端的一个工具，由于我们项目的开发使用了前后端分离，因此swagger显得尤其的重要。

之前用共享文档的方式一起定了接口，写了接口文档，但是实际开发的时候遇到接口的更改那么还要去修改接口文档，这是很麻烦的一件事情，因此，运用swagger帮助我们很好的解决了这个问题。

swagger是第一次接触到，看了一点狂神老师的视频，有了大致的了解之后开始着手使用。

在spring boot中使用swagger的步骤如下：

step1：在spring boot项目的pom.xml文件里面配置swagger依赖

主要有两个依赖，一个是swagger2的依赖，另一个是展示swagger界面的ui依赖，其中版本号可以根据自己的需求选择，可以去swagger官网选择最新的以来版本。

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

step2：swagger 配置文件

swagger的配置文件值得是Java文件，自己在config文件夹（自定义的一个文件夹，以后关于配置相关的类都写在下面即可）新建一个SwaggerConfig.class类：

@Configuration
public class SwaggerConfig {
    @Bean
    public Docket customDocket(Environment environment){
        // 获取项目环境，仅仅在开发或者测试阶段使用swagger，下面的参数可以根据自己的需要配置
        Profiles profiles =  Profiles.of("test", "dev");
        boolean enable = environment.acceptsProfiles(profiles);
        return  new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                // 下面的东西都是可选项，根据自己的需求设置
                .enable(enable) // 在这里设置当前是否展示swagger，默认为true
                .groupName("分组A") // 对接口文档进行分组，非必选项
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xx.controller")) //设置扫描的路径
                //.apis(RequestHandlerSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        Contact contact = new Contact("接口说明文档","http://www.xxx.com","xx@qq.com");
        return  new ApiInfoBuilder()
                .title("项目接口")
                .contact(contact)
                .version("1.0.0")
                .build();
    }
}

配置了上面的Java文件之后，记得在spring boot的启动类里面添加扫描当前config文件的注解：

@SpringBootApplication
@ComponentScan(basePackages = {"com.xxx.config"})
@EnableSwagger2
public class SwaggerApplication {

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

}

step3：swagger界面的访问