目录
百战程序员,全站22050+开发课程+文档 ,学习精选优质好课快人一步!观看视频 快捷键ALT+N

JAVA全系列 教程

3762个小节阅读:7088.3k

收藏
全部开发者教程

C语言快速入门

JAVA全系列 教程

面向对象的程序设计语言

Python全系列 教程

Python3.x版本,未来主流的版本

人工智能 教程

顺势而为,AI创新未来

大厂算法 教程

算法,程序员自我提升必经之路

C++ 教程

一门通用计算机编程语言

微服务 教程

目前业界流行的框架组合

web前端全系列 教程

通向WEB技术世界的钥匙

大数据全系列 教程

站在云端操控万千数据

AIGC全能工具班

A

A A

White Night

阅读(1.8k)
赞(0)

Swagger简介

image-20220715154105706

接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后接口文档又变成重中之重。接口文档固然重要,但是由于项目周期等原因后端人员经常出现无法及时更新,导致前端人员抱怨接口文档和实际情况不一致。很多人员会抱怨别人写的接口文档不规范,不及时更新。如果接口文档可以实时动态生成就不会出现上面问题,Swagger可以完美地解决上面的问题。Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful 风格的 Web 服务,可用于接口的文档在线自动生成以及功能测试。

Open API 是什么 Open API 规范(OpenAPI Specification)以前叫做 Swagger 规范,是REST API 的 API 描述格式。Open API 文件允许描述整个 API,包括:

  • 每个访问地址的类型。POST 或 GET
  • 每个操作的参数。包括输入输出参数
  • 认证方法
  • 连接信息,声明,使用团队和其他信息。

Open API 规范可以使用YAML或 JSON格式进行编写,这样更利于我们和机器进行阅读。

Swagger和Open API

Swagger 是一套围绕 Open API 规范构建的开源工具,可以帮助设计,构建,记录和使用 REST API。Swagger工具包括的组件:

  • Swagger Editor :基于浏览器编辑器,可以在里面编写 Open API规范。类似 Markdown具有实时预览描述文件的功能。
  • Swagger UI:将 Open API 规范呈现为交互式 API 文档。用可视化UI展示描述文件。
  • Swagger Codegen:将 OpenAPI 规范生成为服务器存根和客户端库。通过 Swagger Codegen 可以将描述文件生成 html 格式和 cwiki 形式的接口文档,同时也可以生成多种言语的客户端和服务端代码。
  • Swagger Inspector:和 Swagger UI 有点类似,但是可以返回更多信息,也会保存请求的实际参数数据。
  • Swagger Hub:集成了上面所有项目的各个功能,你可以以项目和版本为单位,将你的描述文件上传到 Swagger Hub 中。在 SwaggerHub 中可以完成上面项目的所有工作,需要注册账号,分免费版和收费版。使用 Swagger,就是把相关的信息存储在它定义的描述文件里面(yml 或 json 格式),再通过维护这个描述文件可以去更新接口文档,以及生成各端代码

实时效果反馈

1.关于Swagger和open API Specification(OAS)说法正确的是

A Swagger是一组工具,它能帮助开发人员设计、构建RestfulAPI文档

B OAS是一种用于描述Restful API的格式

C OAS以前叫作Swagger Sepcification

D 以上都对

答案

1=>D

 

北京市昌平区回龙观镇南店村综合商业楼2楼226室

©2014-2023 百战卓越(北京)科技有限公司 All Rights Reserved.

京ICP备14032124号-2