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

本文记录了在项目中如何使用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界面的访问

http://localhost:8080/swagger-ui.html#/

step4:swagger接口文档的一些解读

swagger对接口的说明是十分详细的,包括了后端返回的参数列表,接口所需参数,接口访问的方法(GET/POST/PUT/DELET等)比自己写文档方便很多!

然后注意到在返回的参数列表的位置,看到上面的图中data是一个空的列表,这是因为swagger无法解析模板类型的数据。我看到网上给的一些解决方案是插入@ApiModel之类的注解,我自己的操作是没有加这些注解也可以实现返回参数类型的解析,展示结果如下:

其实很好实现,在后端的Java代码里面只要给返回的类的类型明确表示出来即可:

所以在写某些返回类型的时候,可能要自定义一些class,设置好相应的get/set方法,则在swagger里面就可以详细的展示出返回的字段的具体名称。

3.总结

swagger的使用不难,不过有些涉及到注解@我还是没有很明白,可以通过阅读官方文档或者源码进一步来学习!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值