java1234课堂 - 专业的java在线教育网       学Java,上Java1234
首页 课程 Java后端技术 API文档框架Swagger3视频教程

API文档框架Swagger3视频教程

学习次数:6973

课程类别:Java后端技术

课程类型:免费课程

免费在线学习该课程
  • 课程介绍

  • 课程目录

  • 课程答疑

  • 高清视频和源码下载

API文档框架Swagger3视频教程

高清视频以及源码文档获取:

关注 java资料站 公众号 回复  swagger   获取

Swagger(丝袜哥)是一个简单但功能强大的API表达工具。它具有地球上最大的API工具生态系统,数以千计的开发人员,使用几乎所有的现代编程语言,都在支持和使用Swagger。使用Swagger生成API,我们可以得到交互式文档,自动生成代码的SDK以及API的发现特性等。

前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低。与swagger2相比新版的swagger3配置更少,使用更加方便。

官网 https://swagger.io/

在线编辑器 http://editor.swagger.io/

Swagger作用:

  • 将项目中所有的接口展现在页面上,这样后端程序员就不需要专门为前端使用者编写专门的接口文档;

  • 当接口更新之后,只需要修改代码中的 Swagger 描述就可以实时生成新的接口文档了,从而规避了接口文档老旧不能使用的问题;

  • 通过 Swagger 页面,我们可以直接进行接口调用,降低了项目开发阶段的调试成本。

 

现在SWAGGER官网主要提供了几种开源工具,提供相应的功能。可以通过配置甚至是修改源码以达到你想要的效果

Swagger Codegen: 通过Codegen 可以将描述文件生成html格式和cwiki形式的接口文档,同时也能生成多钟语言的服务端和客户端的代码。支持通过jar包,docker,node等方式在本地化执行生成。也可以在后面的Swagger Editor中在线生成。

Swagger UI:提供了一个可视化的UI页面展示描述文件。接口的调用方、测试、项目经理等都可以在该页面中对相关接口进行查阅和做一些简单的接口请求。该项目支持在线导入描述文件和本地部署UI项目。

Swagger Editor: 类似于markendown编辑器的编辑Swagger描述文件的编辑器,该编辑支持实时预览描述文件的更新效果。也提供了在线编辑器和本地部署编辑器两种方式。

Swagger Inspector: 感觉和postman差不多,是一个可以对接口进行测试的在线版的postman。比在Swagger UI里面做接口请求,会返回更多的信息,也会保存你请求的实际请求参数等数据。

Swagger Hub:集成了上面所有项目的各个功能,你可以以项目和版本为单位,将你的描述文件上传到Swagger Hub中。在Swagger Hub中可以完成上面项目的所有工作,需要注册账号,分免费版和收费版。

 

 

 

1 Swagger3 简介

2 Swagger3 HelloWorld实现

3 Swagger3 常用配置注解讲解

4 Swagger3 接口测试

5 Swagger3  API信息配置

6 Swagger3 Docket 开关&过滤&分组 配置详解

 

 

vip会员提供课程答疑服务,vip会员请加锋哥QQ:554605804 或者 微信:java9579 拉你进高大上vip专群;

高清视频以及源码文档获取:

关注 java资料站 公众号 回复  swagger   获取