首页
Search
1
关于a标签的onclick事件可能会出现的问题
224 阅读
2
gitignore配置不生效问题
221 阅读
3
mapstruct的简单使用(可能会出现的问题)
194 阅读
4
2023/10/10 LeetCode
186 阅读
5
log4j包依赖冲突
181 阅读
默认分类
前端基础学习
后端学习
swagger
redis
日志管理
刷题记录
2023/10刷题记录
java常见问题
登录
Search
Guardyou3
累计撰写
10
篇文章
累计收到
334
条评论
首页
栏目
默认分类
前端基础学习
后端学习
swagger
redis
日志管理
刷题记录
2023/10刷题记录
java常见问题
页面
搜索到
1
篇与
swagger
的结果
2023-10-15
swagger集成
介绍: swagger是一个文档api,我们使用apiPost测试的时候需要输入地址和各种参数,比较麻烦,我们采用集成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> 编写swagger配置文件: @Configuration @EnableSwagger2 public class SwaggerConfig { //配置swagger的bean实例 @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .groupName("wcy") //分组 .apiInfo(apiInfo()) //select()函数返回一个ApiSelectorBuilder实例,用来控制接口被swagger做成文档 .enable(true) //是否启动 .select() //用于指定扫描哪个包下的接口 .apis(RequestHandlerSelectors.basePackage("com.guardyou")) //选择所有的API,如果你想只为部分API生成文档,可以配置这里 .paths(PathSelectors.any()) //过滤什么路径 .build(); } //配置swagger的信息apiInfo private ApiInfo apiInfo() { return new ApiInfoBuilder() //用来自定义API的标题 .title("SwaggerAPI标题测试") //用来描述整体的API .description("swagger的描述信息") //创建人信息 .contact(new Contact("guardyou3" + "","http://localhost:8081/swagger-ui.html","xxx@qq.com")) //用于定义服务的域名 //.termsOfServiceUrl("") .version("1.0") //可以用来定义版本 .build(); } } 打开浏览器访问swagger-ui.html可以看到已经能够访问文档界面了,并且显示相应的controller,值得注意的是只有出现在controller中的实体类才会被扫描,否则是不会出现在文档中的。点开具体的方法可以看到他已经给我们介绍了具体的用法以及参数示例,我们可以直接进行调用,是不是非常的方便{alert type="success"}swagger常用注解:{callout color="#ef4d4d"}@Api: 作用在类上,表示对类的说明@ApiOperation: 作用在方法上,标注方法的用途@ApiParam: 作用在方法参数或者实体类属性上,表明参数信息,是否必须等描述信息@ApiModel :作用在实体类上,藐视实体信息@ApiModelProperty: 作用在实体类的属性上,描述属性信息@ApiIgnore: 作用在实体类属性上,忽略某个字段使其不显示在文档中{/callout}还有其他swagger相关注解,这里暂不列出{/alert}
2023年10月15日
147 阅读
48 评论
0 点赞