Laravel 安装Swagger

贾珠
• 阅读 1245

一、Swagger是什么
Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

二、Swagger安装

composer require "darkaonline/l5-swagger"

三、配置
安装成功后Laravel配置
在app/Providers/AppServiceProvider 添加

$this->app->register(\L5Swagger\L5SwaggerServiceProvider::class);

或者
在config/app.php 添加

L5Swagger\L5SwaggerServiceProvider::class,

在app\Http\Controllers\Controller.php 写上swagger初始代码(如果不写启动swagger会报错)

/**
 * @OA\Info(title="KIDSERVICE", version="0.1")
 *
 */
class Controller extends BaseController

Laravel发布swagger

 php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

启动运行(每次修改swagger代码都要重新用这个命令刷新运行)
php artisan l5-swagger:generate

浏览器地址栏输入 “域名”+ /api/documentation

效果图
Laravel 安装Swagger

四、总结
优点
Swagger 充当一个RESTful api单元测试,文档注释的作用。在企业前后端分离api功能测试、后端开发团队人员快速知道函数方法和参数所表达的意思和意图。
缺点:
Swagger 有自己一套解释语言,所以等于重新学习一个解释语言(难度不大);会耗费一些开发效率,这等于写一套单元测试和注释。

点赞
收藏
评论区
推荐文章
Easter79 Easter79
3年前
swagger生成接口文档和map类型参数解析
一:swagger是什么?1、是一款让你更好的书写API文档的规范且完整框架。2、提供描述、生产、消费和可视化RESTfulWebService。3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。方法一:使用第三方依赖(最简单的方法)
Wesley13 Wesley13
3年前
java 后台返回文件流到浏览器
packagecom.springbootblog.controller;importio.swagger.annotations.ApiImplicitParam;importio.swagger.annotations.ApiImplicitParams;importio.swagger.annotations.ApiOperation;
Easter79 Easter79
3年前
swagger
如果项目已经集成了swagger,只需要在pom.xml添加,如果你的项目没有集成swagger,自行百度或看最下方的链接swaggerbootstrapui是Swagger的前端UI实现,目的是替换Swagger默认的UI实现SwaggerUI,使文档更友好一点儿....swaggerbootstrapui 只是Swagger的UI实现,
Stella981 Stella981
3年前
Spring Boot demo系列(八):Swagger
2021.2.24更新1概述Swagger主要用于生成API文档,本文演示了如何使用目前最新的OpenAPI3以及Swagger来进行接口文档的生成。2依赖<dependency<groupIdorg.springdoc</groupId
Stella981 Stella981
3年前
Spring MVC 整合 Swagger
Swagger简要说明   将Swagger和SwaggerUI集成到系统中,可以实现接口可视化界面操作。版本号SwaggerUI2.2.10高于该版本,可能会出现“Nooperationsdefinedinspec”错误下载地址:https://github.c
Stella981 Stella981
3年前
SpringBoot整合Swagger3生成接口文档
  前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更少,使用更加方便。一、pom文件中引入Swagger3依赖<dependency
Stella981 Stella981
3年前
Shiro 放行Swagger
一、前言在使用SpringBootShiroMybatisSwagger开发后台权限管理系统的时候,由于SpringBoot采用了Shiro框架,同时API接口文档使用的Swagger,遇到一个问题,在SpringBoot集成Shiro后,访问Swagger接口需要登陆才可以,由于在项目成型之前需要做接口测试,所以这里记录下如何在Shi
Easter79 Easter79
3年前
Swagger从入门到精通
如何编写基于OpenAPI规范的API文档\TOC\前言编写目的本文介绍如何使用Swagger编写API文档。通过阅读本文,你可以:了解swagger是什么掌握使用swagger编写API文档的基本方法涉及范围本文包括对swagger
Wesley13 Wesley13
3年前
Java Swagger的注释类是怎么被调用到的
比如我有一个Swagger2的Java类,里面有一个方法createRestApi,这个方法加了@Bean的注解,负责生成Swagger文档。!在这里插入图片描述(https://oscimg.oschina.net/oscnet/up5af57bfeacc3a353672efb18bff6312d.png)那么Spring框架是如何知道
Easter79 Easter79
3年前
SpringBoot整合Swagger3生成接口文档
  前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更少,使用更加方便。一、pom文件中引入Swagger3依赖<dependency
Easter79 Easter79
3年前
SpringCloud中多个子模块如何集成Swagger文档
不知道大家工作中有没有使用Swagger,可能没有用过,但是肯定或多或少的接触过、听说过,它是一款基于Restfull接口的文档在线生成功能测试的工具。网上有很多SpringBoot如何集成Swagger的教程,但是对于微服务而言,多个模块之前应该如何使用Swagger呢?总不能每个模块单独集成一个,那么当有很多个模块的时候,是
贾珠
贾珠
Lv1
江南二月多芳草,春在蒙蒙细雨中。
文章
7
粉丝
0
获赞
0