Swagger学习笔记一

首先从wikipedia上了解到基本概念https://en.wikipedia.org/wiki/Swagger_(software)

1. 什么是Wagger?

它是一个围绕Open API规范(OAS)构建的开源软件框架, 有大型生态系统的支持, 记录和使用RESTful Web service API. 它允许用户使用Swagger Editor描述OAS 3.0 API(OpenAPI Specification, OAS), 并使用Swagger UI可视化功能自动生成 OAS 3.0的API文档.

Swagger对整个API的开发周期都提供了相应的解决方案. 它是一个规范和完整的框架, 包括API设计,API开发, API文档, API 测试以及API治理等等. 几乎支持所有语言.

• Swagger Editor - 使用它可以创建你的OAS定义.基于浏览器的编辑器, 可以在其中编写OpenAPI的规范文档.
• Swagger Codegen - 然后再用它去生成服务器的实现 . 从OpenAPI规范生成服务器存根和客户端库.
• Swagger UI - 使用它可视化和记录你的OAS定义. 将OpenAPI规范呈现为交互式API文档.
• SwaggerHub - 使用它以团队的形式设计,记录和开发API.

2. Swagger能做什么?

它的工具集包括: 自动生成文档, 生成代码及生成测试用例.主要是提供了托管API文档, 集中定义和存储, API的模拟, 对团队的协作和管理,访问控制,安全共享,风格指南,API生命周期的集成等提供解决方案.

3. Swagger赞助商?

它是由SmartBear Software赞助.SmartBear Software是一家私营信息技术公司.主营程序性能监控,软件开发, 软件测试和API管理提供相关工作. 公司2009年成立, 于2015年收购了开源Swagger的委员会及其创始人- Tony Tam.

4. Swagger历史

2011年: Tony Tam创立了Swagger API项目

5. License

 Apache 2.0 license.

6.版本:

    - 开源:

    - SwaggerHub:提供了托管API文档. 用springfox自动成的json文件导出来, 通过Swagger Editor导入, 可以自动生成API文档.

可以进行API的模拟自动化测试.

    - SwaggerHub Pro:多了一个团队协作, 团队管理.版本控制,团队管理权限,访问控制和安全共享.风格指南.API生命周期的生成.

7. 相关下载链接

Swagger官网: https://swagger.io

Swagger UI 下载: https://github.com/swagger-api/swagger-ui

Swagger Code generation下载:https://github.com/swagger-api/swagger-codegen

Swagger Editor下载: https://github.com/swagger-api/swagger-editor

官网都有live demo可以学习.