冀教网 - 河北教师网站 - 专注于冀教版课本资源

 找回密码
 立即注册
搜索
热搜: 活动 交友 discuz
查看: 266|回复: 0

Swagger2的介绍和使用

[复制链接]

4万

主题

4万

帖子

12万

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
124999
发表于 2020-6-1 09:22 | 显示全部楼层 |阅读模式
Swagger2介绍

前后端分离开发模式中,api文档是最好的沟通方式。
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
及时性 (接口变更后,能够及时准确地通知相关前后端开发人员)规范性 (并且保证接口的规范性,如接口的地址,请求方式,参数及响应格式和错误信息)一致性 (接口信息一致,不会出现因开发人员拿到的文档版本不一致,而出现分歧)可测性 (直接在接口文档上进行测试,以方便理解业务)
配置Swagger2

引入相关依赖
  1.                      org.springframework.boot            spring-boot-starter-web            provided                                     com.baomidou            mybatis-plus-boot-starter            provided                                     org.projectlombok            lombok            provided                                     io.springfox            springfox-swagger2            provided                             io.springfox            springfox-swagger-ui            provided                                     org.springframework.boot            spring-boot-starter-data-redis                    
复制代码
在模块service-base中,创建swagger的配置类

创建包com.soyoungboy.servicebase.config,创建类SwaggerConfig
  1. @Configuration@EnableSwagger2public class SwaggerConfig {    @Bean    public Docket webApiConfig(){        return new Docket(DocumentationType.SWAGGER_2)                .groupName("webApi")                .apiInfo(webApiInfo())                .select()                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))                .paths(Predicates.not(PathSelectors.regex("/error.*")))                .build();    }        private ApiInfo webApiInfo(){        return new ApiInfoBuilder()                .title("网站-课程中心API文档")                .description("本文档描述了课程中心微服务接口定义")                .version("1.0")                .contact(new Contact("Helen", "http://soyoungboy.com", "55317332@qq.com"))                .build();    }}
复制代码
在模块service模块中引入service-base
  1.     com.soyoungboy    service-base    0.0.1-SNAPSHOT
复制代码
5、在service-edu启动类上添加注解,进行测试
  1. @SpringBootApplication@ComponentScan(basePackages = {"com.soyoungboy"})public class EduApplication {    public static void main(String[] args) {        SpringApplication.run(EduApplication.class, args);    }}
复制代码
API模型

可以添加一些自定义设置,例如:
定义样例数据
  1. @ApiModelProperty(value = "创建时间", example = "2019-01-01 8:00:00")@TableField(fill = FieldFill.INSERT)private Date gmtCreate;@ApiModelProperty(value = "更新时间", example = "2019-01-01 8:00:00")@TableField(fill = FieldFill.INSERT_UPDATE)private Date gmtModified;
复制代码
我的关键词 Swagger2的介绍和使用  新闻资讯 554581-20200601090056967-1882883628

定义接口说明和参数说明

定义在类上:@Api
定义在方法上:@ApiOperation
定义在参数上:@ApiParam
  1. @Api(description="讲师管理")@RestController@RequestMapping("/admin/edu/teacher")public class TeacherAdminController {    @Autowired    private TeacherService teacherService;    @ApiOperation(value = "所有讲师列表")    @GetMapping    public List list(){        return teacherService.list(null);    }    @ApiOperation(value = "根据ID删除讲师")    @DeleteMapping("{id}")    public boolean removeById(            @ApiParam(name = "id", value = "讲师ID", required = true)            @PathVariable String id){        return teacherService.removeById(id);    }}
复制代码
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有帐号?立即注册

x
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

Archiver|手机版|小黑屋|冀教网 - 河北教师网站 - 专注于冀教版课本资源  

GMT+8, 2020-7-7 15:03 , Processed in 0.338988 second(s), 30 queries .

Powered by Discuz! X3.2

© 2001-2013 Comsenz Inc.

快速回复 返回顶部 返回列表