微服务(十三)—— Swagger使用

上一篇: 微服务(十二)—— 配置中心(backend-config-server).

1. 介绍

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务,可以在线生成和功能测试。

2. Swagger使用

如何将Swagger集成到项目中呢?

2.1 依赖

首先需要加入swagger的依赖

<!-- swagger 依赖-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
2.2 编写Swagger配置类
package com.aiun.common.config;

@Configuration
@EnableSwagger2  
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(true)
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 基本信息的配置,信息会在 Api 文档上显示
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("订单管理系统测试接口文档")
                .description("订单管理系统所有子系统相关的测试接口文档")
                .version("v1.0")
                .termsOfServiceUrl("http://localhost:8084")
                .version("1.0")
                .build();
    }
}

如果想用在开发和测试环境开启swagger,可以这样配置 Docket。

@Bean
public Docket createRestApi(Environment environment){
    // 设置要显示的 Swagger 环境
    Profiles profiles = Profiles.of("dev", "test");
    // 通过 acceptsProfiles 方法判断是否在自己设定的环境当中
    boolean show = environment.acceptsProfiles(profiles);
    
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .enable(show)  // 是否启用 swagger
            .select()
            .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
            .paths(PathSelectors.any())
            .build();
}

配置完成后,在需要的接口加注释说明就好。
首先是 Controller层
在类上使用@Api 注解

@Api(tags = "订单系统相关接口")

tags说明信息

在方法上使用@ApiOperation注解

@ApiOperation(value = "用户登录", notes = "用户登录")

如下:

@Api(tags = "用户系统相关接口")
@RestController
@RequestMapping("/user/")
public class UserController {
    @Autowired
    private IUserService iUserService;
    @Autowired
    private RedisTemplate<String, String> redisTemplate;

    /**
     * 用户登录
     * @param username 用户名
     * @param password 密码
     * @return 返回登录信息
     */
    @PostMapping("login")
    @ApiOperation(value = "用户登录", notes = "用户登录")
    public ServerResponse<User> login(String username, String password) {
        ServerResponse<User> response = iUserService.login(username, password);
        return response;
    }
    //.......
}

在数据库对应的实体类使用@ApiModel 注解

@ApiModel(value = "user对象", description = "用户表")

在实体类的属性上使用 @ApiModelProperty 注解

@ApiModelProperty(value = "用户名")

如下:

@Data
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode
@Accessors(chain = true)
@ApiModel(value = "user对象", description = "用户表")
public class User implements Serializable {
    
    @ApiModelProperty(value = "用户表 主键")
    private Integer id;
    
    @ApiModelProperty(value = "用户名")
    private String username;
    
    //......    
}

然后启动项目,在浏览器输入http://localhost:8084/backend-user/swagger-ui.html,地址就会出现UI界面
在这里插入图片描述
每一个接口都可以测试。
在这里插入图片描述

  • 2
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
若依微服务是一种基于Spring Cloud的微服务架构,它提供了一套完整的解决方案来快速构建和部署分布式系统。Swagger文档是一种用于描述和展示API接口的工具,可以方便开发人员和测试人员理解和调用接口。 在若依微服务中,可以通过更换Swagger文档来实现以下几个方面的需求: 1. 支持更多的API文档格式:目前,Swagger文档使用的是OpenAPI规范,可以方便地生成和展示API接口文档。但是有时候,我们可能需要支持其他类型的API文档格式,比如RAML、API Blueprint等。通过更换Swagger文档,我们可以灵活选择适合自己的API文档格式。 2. 自定义API文档样式:Swagger文档默认提供了一套简洁的样式和布局,但是它可能不符合我们的品牌和设计要求。通过更换Swagger文档,我们可以自定义API文档的样式,包括颜色、字体、布局等,以适应我们的品牌形象。 3. 扩展API文档功能:Swagger文档提供了一些基本的功能,比如生成API文档、调试接口、测试接口等。但是在实际应用中,我们可能需要更多的功能来满足特定的需求,比如权限控制、数据模型关联等。通过更换Swagger文档,我们可以集成其他的API文档工具或者自行开发插件来扩展API文档的功能。 总之,若依微服务更换Swagger文档可以帮助我们实现更多定制化和扩展性的需求,从而更好地满足项目的特定要求。通过更换Swagger文档,我们可以选择适合自己的API文档格式、样式和功能,提高团队的开发效率和项目的可维护性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值