顾乔芝士网

持续更新的前后端开发技术栈

WebApi 集成 Swagger

1. Swagger(俗称:丝袜哥)是什么东西?

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

使用Swager API Docs和easy-mock生成模拟数据

前面文章已经搭建了本地的easy-mock

还在用Swagger?试试这款零注解侵入的API文档生成工具

前后端接口联调需要API文档,我们经常会使用工具来生成。之前经常使用Swagger来生成,最近发现一款好用的API文档生成工具smart-doc, 它有着很多Swagger不具备的特点,推荐给大家。

中年大叔学编程-Gin-Swagger生成API接口文档

最近简单的学习了一下Golang,并且用Gin开发了两个小应用,一个短域名生成,一个微信小程序。感受到了Golang的代码简洁、部署简单、内存占用少、零停机平滑重启等优势。在开发小程序的时候,需要生成接口文档,这里需要用到Gin-Swagger了,所以简单的就来整理一下。

这里我用的环境是:

  • go version go1.14.6 windows/amd64
  • GoLand 2020.2.1
  • gin v1.6.3

swagger添加权限验证,保证API(接口)安全性

当我们使用swagger,进行接口测试,怕接口不安全,担心暴露。可以采用两种方式

环境权限配置

可以对swagger文档配置只在测试环境可访问,生产环境不可访问。

@Profile({"dev","test"})

gin整合knife4j swagger (go整合knife4j)

最近学习go语言,使用gin框架,在整合knife4j swagger时,发现资料非常少,整合之后也有很多不如意,所以自己整合了一个学习项目:项目地址
https://gitee.com/longyancang/knife4jgo

1.支持自定义panic拦截器

2.支持参数验证错误描述拦截

3.支持自定义响应体

再见Swagger UI 国人开源了一款超好用的 API 文档生成框架,真香

背景

最近,栈长发现某些国内的开源项目都使用到了 Knife4j 技术,看名字就觉得很锋利啊!

swagger-bootstrap-ui:swagger改进版本,界面更美观易于阅读

swagger作为一款在线文档生成工具,用于自动生成接口API,避免接口文档和代码不同步,但原生的界面不是很友好,下面介绍一款改进版本swagger-bootstrap-ui,界面左右侧布局,可以打开多个Tab页。

实现也非常简单,在swagger2配置基础上仅多添加一个依赖并在配置类上追加@EnableSwaggerBootstrapUI注解即可,无任何其他多余配置。

看下Springboot集成步骤:

再见 Swagger!国人开源了一款超好用的 API 文档生成框架真香

Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍!

Springboot集成Swagger2及常见配置(无坑版)

本文出自《愚公要移山》

控制面板
您好,欢迎到访网站!
  查看权限
网站分类
最新留言