手记

【金秋打卡】第六天+Swagger学习

课程名称:Swagger文档接口神器

课程章节:全部

主讲老师:晴天哥


课程内容:

之前学习在线协同办公小程序的时候,跟着神思者老师搭建了一般,但是老师是直接操作的,所以看了看慕课网有没有基础类的课程,搜到了这个课程,学习的途中发现老师是讲解一下Swagger是干什么用的,然后就是给源码,让放到项目里面,然后继续讲解。

感觉吧,讲的可能不是那么明白,但是起码也明白了一些东西,虽然不多,其实配置类的东西要记也记不住,还是主要是项目里面怎么把配置好的东西应用到项目里面吧。

最后的话,就是把收获写道后面吧,写了一些重点,边边角角没写,还是主要学会如何使用最重要,有兴趣的同学也建议听听,不过最好还是之前接触过Swagger,听课效果会更好!


课程收获:

Swagger2依赖

  1. <!-- swagger依赖1 -->
    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>2.9.2</version>
    </dependency>
    <!-- swagger依赖2 -->
    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <version>2.9.2</version>
    </dependency>


Swagger2注解总结

  1. 用于Controller

    1. @Api  对请求类的说明

  2. 用于方法上面——说明参数的含义

    1. @ApiOperation  方法的说明

    2. @ApiImplicitParams、@ApilmplicitParam  方法的参数说明,@ApiImplicitParamsy用于指定单个参数的s说明

  3. 用于方法上面——返回参数或对象的说明

    1. @ApiResponses、@ApiResponse  方法返回值说明;@ApiResponsesy用于指定单个参数的说明

  4. 对象类

    1. @ApiModel  用于JavaBean类,说明JavaBean的用途

    2. @ApiModelProperty   用于JavaBean类的属性上面,说明此属性的含义

Swagger项目地址

https://github.com/Fighting/spring-boot-wagger2  (地址我改了)

革命尚未成功,通知还需努力啊!




0人推荐
随时随地看视频
慕课网APP