# apidoc-swagger-samples

**Repository Path**: OlinOnee/apidoc-swagger-samples

## Basic Information

- **Project Name**: apidoc-swagger-samples
- **Description**: SpringBoot swagger相关使用以及和knife4j的整合。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-07-03
- **Last Updated**: 2024-05-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 基本术语介绍
- OpenAPI是规范的正式名称，即开放 API，也称开放平台。 所谓的开放 API（OpenAPI）是服务型网站常见的一种应用，网站的服务商将自己的网站服务封装成一系列 API（Application Programming Interface，应用编程接口）开放出去，供第三方开发者使用，这种行为就叫做开放网站的 API，所开放的 API 就被称作 OpenAPI（开放 API ）。 OpenAPI规范始于Swagger规范，经过Reverb Technologies和SmartBear等公司多年的发展，OpenAPI计划拥有该规范（捐赠之后），OpenAPI Initiative在GitHub上托管社区驱动的规范。
- Swagger
  - 是一个 API文档维护组织，后来成为了 Open API 标准的主要定义者。现在最新的版本为17年发布的 Swagger3（Open Api3）。
  - 是一个Open API规范实现工具包，由于Swagger工具是由参与创建原始Swagger规范的团队开发的，因此通常仍将这些工具视为该规范的代名词。目前可以认为Swagger3就是Open API 3.0
- OpenAPI 3.0：2017年7月，Open API Initiative最终发布了OpenAPI Specification 3.0.0。它对2.0规范进行了很多改进。Open API 3.0规范可以用JSON或YAML编写，并且在记录RESTful API方面做得很好。同时标志着Swagger2成为过去式。
- SpringFox是 spring 社区维护的一个项目（非官方），帮助使用者将 swagger2 集成到 Spring 中。常常用于 Spring 中帮助开发者生成文档，并可以轻松的在spring boot中使用。截至2020年4月，尚未支持 OpenAPI3 标准。
- SpringDoc也是 spring 社区维护的一个项目（非官方），帮助使用者将 swagger3 集成到 Spring 中。也是用来在 Spring 中帮助开发者生成文档，并可以轻松的在spring boot中使用。

OpenAPI规范地址：https://github.com/OAI/OpenAPI-Specification

OpenAPI 3.0规范地址：https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.0.md

Swagger官网地址：https://swagger.io/

SpringFox官网地址：http://springfox.github.io/springfox/

SpringDoc官网地址：https://springdoc.org/

## 各模块文档详细介绍
[springdoc-openapi-sample](./springdoc-openapi-sample/README.md)

[swagger-v2-sample](./swagger-v2-sample/README.md)

[swagger-v3-sample](./swagger-v3-sample/README.md)