springboot日记之初入swag

## 什么是swag?Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。简单来说,可以更友好的展示自己对外的API,调用、测试更加方便、轻松。下面的操作都是以maven构建的springboot项目为基础。...
摘要由CSDN通过智能技术生成

## 什么是swag?
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。简单来说,可以更友好的展示自己对外的API,调用、测试更加方便、轻松。
下面的操作都是以maven构建的springboot项目为基础。

  1. 首先要做的就是引入swag的jar包
		<dependency>
		    <groupId>io.springfox</groupId>
		    <artifactId>springfox-swagger2</artifactId>
		    <version>2.5.0</version>
		</dependency>
  1. 配置config类
@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
        // 为当前包路径
                .apis(RequestHandlerSelectors.basePackage("learn.controller")).paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
        // 页面标题
                .title("练手搭建springboot项目")
                // 创建人
                // .contact(new Contact("ljg", "http://blog.bianxh.top/", ""))
                // 版本号
                .version("1.0")
                // 描述
                .description("API 描述").build();
    }
}
  1. 注解需要暴露的接口
@Api(value = "用户", tags = { "用户
  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值