swagger的使用

  • 接口文档对前后端开发人员非常重要,swagger 是基于open api规范构建开源工具,
    swagger组件有
    swagger editor 基于浏览器编辑器,
    swagger ui 可视化ui展示描述文件 ,
    swagger inspector 和ui组件很像,可以返回更多信息,会保存请求实际参数,
    spring fox 是可以根据代码生成接口文档,所以描述文件是根据项目来变化的,不用手动更新,
    springboot导入spring-fox依赖就是导入了wagger,
    在启动类上添加@EnableSwagger2注解,添加这个注解后表示启动项目就会启动swagger组件,对当前项目全部控制器进行扫描,
    访问swagger-ui
    启动项目后在浏览器中输入 http://ip:port/swagger-ui.html
    在swagger-ui中可视化操作项目接口,

  • swagger配置
    可以在项目中创建SwaggerConfig 配置对象来进行配置文档内容
    Docket对象 通过这个对象配置描述文件信息
    通过apis()方法来设置哪些包中的内容被扫描,

  • 常用注解
    @Api
    是类上注解 控制了整个类生成接口信息的内容,属性tags 类的名字 description描述
    @ApiOperation 写在方法上的注解,对方法进行描述, 属性value 方法描述 notes 提示信息
    @ApiParam 写在方法参数中的注解,用于对参数进行描述,说明一下是否是必填项,属性有 name 参数名字 value参数描述 required是否是必须
    @ApiModel是类上注解,主要应用在实体类上,属性value 类名称,description 是描述
    @ApiModelproperty可以应用在方法上或是属性上,用于方法参数是应用类型时进行定义描述
    @Apilgnore 用于类上方法上参数上,表示被忽视,

  • 前后端分离
    一般使用vue+springboot
    后端:后端控制层 服务层 数据访问层
    前端:前端控制层 视图层
    前后端交互 API
    创建springboot项目 导入对应的依赖
    在这里插入图片描述
    启动swagger界面查看
    在这里插入图片描述

配置swagger
swagger有自己的配置实例对象 Docket
这个对象方法中有多个属性
apiinfo属性是配置swagger显示的信息
select()配置扫描接口
groupname()配置api文档的分组 配置多个Docket实例可以实现多个分组,多个@bean
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

Swagger是一个用于设计、构建和文档化RESTful Web服务的开源工具集。下面是一个简单的Swagger使用教程: 1. 安装Swagger:可以通过npm、pip等包管理工具安装Swagger相关的库和工具。例如,对于Node.js项目,可以使用以下命令安装swagger-jsdoc和swagger-ui-express: ```bash npm install swagger-jsdoc swagger-ui-express ``` 2. 编写Swagger注解:在你的API代码中,使用Swagger注解来描述API的信息、请求和响应参数等。以下是一个示例: ```javascript /** * @swagger * /api/users: * get: * summary: 获取所有用户 * description: 获取所有用户列表 * responses: * 200: * description: 成功获取用户列表 * schema: * type: array * items: * $ref: '#/definitions/User' */ ``` 在这个示例中,我们使用Swagger注解来描述一个GET请求,它可以获取所有用户的列表。 3. 生成Swagger文档:使用Swagger注解编写完API代码后,可以使用相应的工具将这些注解转换为Swagger文档。例如,对于Node.js项目,我们可以使用swagger-jsdoc库生成Swagger文档。在项目的入口文件中添加以下代码: ```javascript const swaggerJSDoc = require('swagger-jsdoc'); const swaggerUi = require('swagger-ui-express'); const options = { definition: { openapi: '3.0.0', info: { title: 'API文档', version: '1.0.0', }, }, apis: ['./path/to/api/controllers/*.js'], // API代码文件的路径 }; const swaggerSpec = swaggerJSDoc(options); app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec)); ``` 这段代码将会在`/api-docs`路径下提供Swagger文档。 4. 查看Swagger文档:运行项目并访问`/api-docs`路径,你将会看到生成的Swagger文档。Swagger提供了一个交互式的UI界面,可以方便地查看API的信息、请求和响应参数等。 这只是一个简单的Swagger使用教程,你可以根据自己的项目需求进一步深入学习和使用Swagger
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值