第一章 Swagger简介

1-1  API

概念:

           API (Application Programming Interface ,应用程序接口)是一-些预先定义的接口(如函数、HTTP接口)，或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程, 而又无需访问源码，或理解内部工作机制的细节。

作用:

         通过API一个系统可以使用其他系统提供的功能，而无需了解这个系统的内部。通过API接口实现计算机软件之间的相互通信。通俗的说，把某些功能封装好，方便其他人调用，规定了如何与外界沟通+如何发送请求和接受响应。以上所说的API不是java的接口interface.

API内容：

项目中常使用word, html， pdf 等格式展示API的详细内容。
主要包含内容:
①接口名称。
②简要描述。
③请求的URL。
④请求方式(GET /POST等)。
⑤请求参数(参数名、是否必选、参数类型、说明)。
⑥返回示例。
⑦返回参数说明(参数名、类型、说明)
⑧备注及责任人。
⑨项目整体信息

 

1-2  Swagger

【官网】https://swagger.io/

Swagger  是- -组围绕OpenAPI规范构建的开源工具，可以帮助您设计、构建、记录和使用REST APIs。

主要的Swagger工具包括:
        ●Swagger Editor--基 于浏览器的编辑器，您可以在其中编写OpenAPI规范。
        ●Swagger UI一-将OpenAPI规范呈现为交互式API文档。
        ●swagger Codegen -根据QpenAPI 规范生成服务器存根和客户端库。

作用：

OpenAPI规范了API的结构，Swagger 使用多种方式推动API的开发。
        ●使用 Swagger Codegen 为你的API生成一个服务器存根。也就是自动生成接口有关的代码，开发人员实现服务器逻辑就可以了。应用编程接口已经准备好投入使用了! Swagger Codegen 支持40多种语言
        ●swaggerUI，编写应用编程接口文档。直接在浏览器中尝试应用编程接口调用。
        ●生成接口文档，能够保持和服务器的同步
        ●接口功能测试

1-3  SpringFox开源库

1.  是一个工具库，在代码中来生成OpenAPI的文档
2.  Springfox:是一个开源的APIDoc的java库，它的前身是swagger-springmvc,，可以将我们的Cotroller中的方法以文档的形式展现。
3. 官方定义为: Automated JSON API documentation for AP's built with Spring。基于Swagger规范，可以将SpringMVC和Spring Boot项目的项目代码，自动生成JSON格式的描述文件。本身不是属于Swagger提供的，是独立的开源项目。

 

 

第二章  Swagger入门

步骤

1. 创建spring   boot  项目
2. 添加依赖-> springfox   、springfox  swagger UI
3. 新建controller , 定义方法，每一个方法就是一个接口
4. 使用swagger-ui  展示 json 文档
5. 浏览器中访问

 

标签：swagger,接口,OpenAPI,API,文档,笔记,Swagger,节点
来源： https://www.cnblogs.com/xclqmc/p/15562333.html