Swagger
文章平均质量分 61
Swagger
不死鸟.亚历山大.狼崽子
太极计算机股份有限公司系统架构师,从事ios、.net、flex、java等开发
展开
-
Swagger(5):Swagger2常用注解
ApiIgnore用于方法或类或参数上,表示这个方法或类被忽略。和之前讲解的自定义注解@MyAnnotation4Swagger效果类似。只是这个注解是Swagger内置的注解,而@MyAnnotation4Swagger是我们自定义的注解。@ApiImplicitParam用在方法上,表示单独的请求参数,总体功能和@ApiParam类似。@ApiOperation写在方法上,对方法进行总体描述。@Api是类上注解。效果示例:在swagger-ui中显示效果。效果示例:在swagger-ui中显示效果。原创 2023-11-20 09:34:51 · 203 阅读 · 0 评论 -
Swagger(4):Swagger配置
3.1自定义注解注解名称随意,我这边新建MyAnnotation4Swagger。/*** @Target - 描述当前的注解可以定义在什么资源上。* 属性 value* - 定义具体的资源。包括:* - ElementType.METHOD 可以定义在方法上* - ElementType.TYPE 可以定义在类型上* - ElementType.FIELD 可以定义在属性上* - ElementType.PARAMETER 可以定义在方法参数上。原创 2023-11-18 19:24:53 · 263 阅读 · 0 评论 -
Swagger(3):Swagger入门案例
在项目的pom.xml中导入Spring-fox依赖。目前最新版本为2.9.2,所以导入的依赖也是这个版本。其中springfox-swagger2是核心内容的封装。springfox-swagger-ui是对swagger-ui的封装。启动项目后在浏览器中输入http://ip:8080/swagger-ui.html即可以访问到swagger-ui页面,在页面中可以可视化的进行操作项目中所有接口。在SpringBoot的启动类中添加@EnableSwagger2注解。应用Swagger2。原创 2023-11-18 18:04:27 · 231 阅读 · 0 评论 -
Swagger(2):Springfox简介
使用Swagger时如果碰见版本更新或迭代时,只需要更改Swagger的描述文件即可。但是在频繁的更新项目版本时很多开发人员认为即使修改描述文件(yml或json)也是一定的工作负担,久而久之就直接修改代码,而不去修改描述文件了,这样基于描述文件生成接口文档也失去了意义。Spring-fox利用自身AOP特性,把Swagger集成进来,底层还是Swagger。但是使用起来确方便很多。Spring-fox是根据代码生成接口文档,所以正常的进行更新项目版本,修改代码即可,而不需要跟随修改描述文件。原创 2023-09-13 17:01:30 · 260 阅读 · 0 评论 -
Swagger(1):Swagger简介
接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后接口文档又变成重中之重。接口文档固然重要,但是由于项目周期等原因后端人员经常出现无法及时更新,导致前端人员抱怨接口文档和实际情况不一致。很多人员会抱怨别人写的接口文档不规范,不及时更新。但是当自己写的时候确实最烦去写接口文档。这种痛苦只有亲身经历才会牢记于心。如果接口文档可以实时动态生成就不会出现上面问题。Swagger可以完美的解决上面的问题。原创 2023-09-13 16:59:21 · 152 阅读 · 0 评论