平武建站

怎么在SpringBoot中利用Swagger构建一个api文档-创新互联

怎么在SpringBoot中利用Swagger构建一个api文档？相信很多没有经验的人对此束手无策，为此本文总结了问题出现的原因和解决方法，通过这篇文章希望你能解决这个问题。

成都创新互联主要从事成都做网站、成都网站建设、网页设计、企业做网站、公司建网站等业务。立足成都服务永吉,10年网站建设经验,价格优惠、服务专业,欢迎来电咨询建站服务:13518219792

Swagger是什么：THE WORLD'S MOST POPULAR API TOOLING


根据官网的介绍：

Swagger Inspector：测试API和生成OpenAPI的开发工具。Swagger Inspector的建立是为了解决开发者的三个主要目标。

1、执行简单的API测试

2、生成OpenAPI文档

3、探索新的API功能

我的理解Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。简单来说，Swagger是一个功能强大的接口管理工具，并且提供了多种编程语言的前后端分离解决方案。根据我的使用，当然我只是最简单的使用，我感觉Swagger有以下几个优点：

1、Swagger可以整合到代码中，在开发时通过注解，编写注释，自动生成API文档。

2、将前端后台分开，不会有过分的依赖。

3、界面清晰，无论是editor的实时展示还是ui的展示都十分人性化，如果自己仅仅用markdown来编写，又要纠结该如何展现，十分痛苦。

下面的两点我还没有进行实践：

1、支持Json和yaml来编写API文档，并且支持导出为json、yaml、markdown等格式

2、如果编写好了API了，可以自动生成相应的SDK，没错，可能你的API接口代码还没有开始写，它就能帮你制作相应的SDK了，而且支持几乎所有主流编程语言的SDK。

SpringBoot,Maven构建SwaggerAPI文档

第一步：创建SpringBoot Web项目

在这里就不过多进行介绍，只是说一下可能出现的问题：创建好项目之后目录结构不对，只有src/main/resources文件夹。下图所示

怎么在SpringBoot中利用Swagger构建一个api文档

这时候只需要将JDK版本升级到你安装的版本就可以，其他文件夹就可以显现出来：

怎么在SpringBoot中利用Swagger构建一个api文档

第二步：创建类以及配置pom.xml

1：配置pom.xml，添加依赖包：

第一个是API获取的包，第二是官方给出的一个ui界面。三和四是spring boot 需要的jar包。

  
    io.springfox
    springfox-swagger2
    2.6.1
  

  
    io.springfox
    springfox-swagger-ui
    2.6.1
  

  
    org.springframework.boot
    spring-boot-starter-web
  

  
    org.springframework.boot
    spring-boot-starter-test
    test

本文名称：怎么在SpringBoot中利用Swagger构建一个api文档-创新互联
URL网址：http://pwwzsj.com/article/codsoc.html

其他资讯