文档章节

【Swagger2】【3】API注解详解,以及注解常用参数配置

o
 osc_g8254g7s
发布于 2019/08/19 21:42
字数 350
阅读 0
收藏 0

精选30+云产品,助力企业轻松上云!>>>

前言:

@Api,@ApiOperation,@ApiImplicitParam,@ApiModelProperty

正文:

一,Controller层

@CrossOrigin(origins = "*")
@RestController
@Api(tags = {"文章接口"})
public class ArticleController {
    @ApiOperation(value = "文章详情")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "文章编号", required = true, dataType = "String", paramType = "query", example="12345"),
    })
    @RequestMapping(value = "article", method = RequestMethod.GET)
    public Result<Article> getArticleInfo(String id) {
        return this.theService.getArticleInfo(id);
    }
}

@Api:作用在类上,用来标注该类具体实现内容。

参数:

1,tags:该类的名称
2,description:描述该类的作用

 

@ApiOperation:表示一个http请求的操作

参数:

1,value : 接口名称

 

@ApiImplicitParam:接口的单个请求参数 ,根据需要选择

参数:

1,name :参数名 

2,value : 描述参数名 

3,required : 该参数是否必填

4,dataType :参数的数据类型 

4,example:举例 

6, paramType :查询参数类型。这里有几种形式:

类型 作用
path 以地址的形式提交数据
query 直接跟参数完成自动映射赋值
body 以流的形式提交 仅支持POST
header  参数在request headers 里边提交
form 以form表单的形式提交 仅支持POST

二,如果传入的参数是用实体类接收的

public class AddVo {
    @ApiModelProperty(name="province", value="所在省", required=true)
    private String province;

    @ApiModelProperty(name="city", value="所在市", required=true)
    private String city;
}

@ApiModelProperty:同@ApiImplicitParam一致

参考博客:

SwaggerAPI注解详解,以及注解常用参数配置 - 都让你们叫老了的博客 - CSDN博客
https://blog.csdn.net/java_yes/article/details/79183804

o
粉丝 0
博文 500
码字总数 0
作品 0
私信 提问
加载中
请先登录后再评论。
Springboot系列(七) 集成接口文档swagger,使用,测试

Springboot 配置接口文档swagger 往期推荐 SpringBoot系列(一)idea新建Springboot项目 SpringBoot系列(二)入门知识 springBoot系列(三)配置文件详解 SpringBoot系列(四)web静态资源配...

全栈学习笔记
04/20
0
0
Springboot系列(七) 集成接口文档swagger,使用,测试

Springboot 配置接口文档swagger 往期推荐 SpringBoot系列(一)idea新建Springboot项目 SpringBoot系列(二)入门知识 springBoot系列(三)配置文件详解 SpringBoot系列(四)web静态资源配...

全栈学习笔记
04/20
0
0
Spring Boot中使用Swagger2自动构建API文档

由于Spring Boot能够快速开发、便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API。而我们构建RESTful API的目的通常都是由于多终端的原因,这些终端会共用很多底层业...

osc_o37lu093
2019/04/17
4
0
spring boot 1.5.4 集成Swagger2构建Restful API(十八)

上一篇博客地址:springboot 1.5.4 整合rabbitMQ(十七) 1 Spring Boot集成Swagger2构建RESTful API文档 1.1 Swagger2简介 Swagger2官网:http://swagger.io/ 由于Spring Boot能够快速开发、...

wyait
2017/11/03
0
0
Spring Boot集成Swagger

Spring Boot集成Swagger 目录 Spring Boot集成Swagger 前言 为了完成项目自带文档的需求,花了一定的时间研究集成。看了官方文档和一些博客,差不多搭出一个比较通用的架子。 文末会分享出案...

osc_4snbwzam
05/26
4
0

没有更多内容

加载失败,请刷新页面

加载更多

asp.net core之NLog

NuGet添加 NLog.Web.AspNetCore。 <PackageReference Include="Microsoft.AspNetCore.App" /> 添加配置文件 新建一个文件nlog.config(建议全部小写,linux系统中要注意), 并右键点击其属性......

一介草民Coder
33分钟前
23
0
.NET中的struct和class有什么区别? - What's the difference between struct and class in .NET?

问题: .NET中的struct和class有什么区别? 解决方案: 参考一: https://stackoom.com/question/3OT/NET中的struct和class有什么区别 参考二: https://oldbug.net/q/3OT/What-s-the-differ...

富含淀粉
今天
23
0
android:layout_weight是什么意思? - What does android:layout_weight mean?

问题: I don't understand how to use this attribute. 我不明白如何使用这个属性。 Can anyone tell me more about it? 谁能告诉我更多关于它的事情? 解决方案: 参考一: https://stacko...

javail
今天
17
0
CSS背景不透明度[重复] - CSS Background Opacity [duplicate]

问题: This question already has an answer here: 这个问题已经在这里有了答案: How do I give text or an image a transparent background using CSS? 如何使用CSS为文本或图像提供透明背...

fyin1314
今天
31
0
node http 获取gb2312网页如何转为utf8

最初,我想当然认为是下述做法,但被证明是错误的 const http = require('http'), iconv = require('iconv-lite');const url = 'http://xxx';http.get(url, function(res) { var bo......

高延
今天
24
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部