美文网首页
swagger生成在线接口文档

swagger生成在线接口文档

作者: 蜜思1013 | 来源:发表于2019-04-17 21:09 被阅读0次

1.swagger简介

Swagger是全球最大的API开发框架,这个框架以“开放API声明(OpenAPI Specification,OSA)”为基础,支持整个API生命周期的开发。它可以和SpringMVC整合,并且通过结合Swagger-ui组件,将controller层的方法进行可视化的展示,像方法注释,方法参数,方法返回值等都提供了相应的用户界面。用户可以在该界面对每个接口进行测试。
OSA,本身是一个规范,它是一个描述一整套API接口的json文件,包括接口的请求方式,参数,header等等信息。

2.swagger使用

  • 在pom.xml中添加依赖
<dependency>
      <groupId>com.spring4all</groupId>
        <artifactId>swagger-spring-boot-starter</artifactId>
        <version>1.8.0.RELEASE</version>
      </dependency>
  • 在resources下properties添加配置
#swagger配置
swagger.enabled=true
swagger.title=spring-boot-mybatis module api
swagger.description=Starter for swagger 2.x
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=WKX
swagger.contact.url=https://www.jianshu.com/u/0640fefbc8bf
swagger.contact.email=2413890705@qq.com
swagger.base-package=com.springboot.mybatis.controller
swagger.base-path=/**
swagger.exclude-path=/error, /ops/**
  • 在主应用application添加注释
@EnableSwagger2Doc

接下来可以登录网址进行测试http://localhost:8080/swagger-ui.html

启动应用主类可进行测试

相关文章

  • Swagger代码实战

    什么是Swagger Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagger...

  • SpringBoot+Swagger+日志

    一.Swagger 1.Swagger简介 swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功...

  • 接口调试神器——Swagger

    Swagger介绍 最好的API构建工具。 自动生成在线接口文档; 集成接口在线调试; 使用非常简单; 社区活跃;...

  • Spring Boot使用Swagger2构建restful A

    什么是swagger? Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagge...

  • swagger生成在线接口文档

    1.swagger简介 Swagger是全球最大的API开发框架,这个框架以“开放API声明(OpenAPI Sp...

  • swagger生成在线接口文档

    swagger的由来 随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形...

  • 二十三、Spring Boot使用Swagger2生成API文档

    一、Swagger2概念 Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。 Swag...

  • Springboot+Swagger生成在线文档、离线文档

    生成在线文档(不细说,很多可用的教程) 加好注解接口的注解model的注解 生成离线文档 将Swagger2文档导...

  • Swagger

    1.简介 Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件 Swagger 是一个规范...

  • 什么是 Swagger?

    Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。 Swagger 是一个规范和完整的...

网友评论

      本文标题:swagger生成在线接口文档

      本文链接:https://www.haomeiwen.com/subject/oxvmvqtx.html