首页 > 其他分享 >Swagger-自动生成接口文档

Swagger-自动生成接口文档

时间:2024-03-07 20:57:12浏览次数:24  
标签:接口 api 文档 Swagger com localhost

Swagger

官网:https://swagger.io/

Swagger3是接口文档生成工具

依赖 pom.xml

<dependency>
	<groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
    <version>4.4.0</version>
</dependency>

配置文件 application.yml

server:
  port: 8080
  servlet:
    context-path: /api     # 如果填写接口文档地址则为api/doc.html   
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/library-management?serverTimezone=GMT%2b8
    username: root
    password: 123456
# 支持 swagger3
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher
      
# 接口文档配置
knife4j:
  enable: true
  openapi:
    title: "接口文档"
    version: 1.0
    group:
      default:
        api-rule: package
        api-rule-resources:
          - com.example.springboot.controller  # 写自己的包

然后我们启动项目

http://localhost:8080/api/doc.html#/home (我的接口文档地址)

打开后就能看到接口文档页面

http://localhost:8080/api/v2/api-docs (这里可以看到Swagger源码)

标签:接口,api,文档,Swagger,com,localhost
From: https://www.cnblogs.com/HanXuxian/p/18059723

相关文章

  • 安装ML.NET命令行接口(CLI)工具遇到的坑
    根据微软官方文档(https://learn.microsoft.com/zh-cn/dotnet/machine-learning/how-to-guides/install-ml-net-cli?tabs=windows)安装ML.NET命令行接口(CLI)工具时执行如下命令:dotnettoolinstall--globalmlnet-win-x64始终报从指定的Nuget源中找不到对应的工具: 以为是......
  • SpringBoot 支付宝付款接口类、支付异步回调函数模板
    1.付款接口类1.1.引入Maven依赖<dependency><groupId>com.alipay.sdk</groupId><artifactId>alipay-sdk-java</artifactId><version>4.38.221.ALL</version></dependency>1.2.将下面代码保存为AlipayTemplate.java@Config......
  • 高德接口-前端本地开发调用代理
    请求中api:exportfunctionjPAmapApi(data){returnrequest({url:'/v4/grasproad/driving?key=b03c9b62740951fd7fb9bba7f5be1c4f',method:'post',data:data,headers:{'content-type':'applicatio......
  • 电商API接口入门指南 (淘宝商品详情店铺)
    电商API接口入门指南旨在为初学者提供关于电商API接口的基本知识和使用方法的指导。以下是一个简要的入门指南,帮助你开始使用电商API接口。一、了解API接口的基本概念首先,你需要了解API接口的基本概念。API(ApplicationProgrammingInterface,应用程序编程接口)是不同软件应用程序......
  • 接口调试工具
    Apifox将数据库备注导入apifox常用参数SELECTdistinctCOLUMN_NAME,table_name,DATA_TYPE,COLUMN_COMMENT,CONCAT(COLUMN_NAME,',',COLUMN_COMMENT)as'apifox常用参数'FROMinformation_schema.COLUMNSWHEREtable_schema......
  • C++语言代码开发示例-身份证实名认证接口
    实名认证API实时联网核验个人身份信息与所持身份证件人员的一致性,可满足不同应用场景的不同实名认证需求,如身份证号+姓名核验、身份证号+姓名+人像核验、身份证号+姓名+证件人像+现场人像核验等,有助于推动诚信网络环境建设,降低利用网络进行违法犯罪的可能性,防止纠纷和诈骗,确保消费......
  • 淘宝详情api接口的应用
    淘宝详情API接口是一个基于HTTP协议的接口服务,可用于获取淘宝商品的具体信息。下面将介绍如何调用淘宝详情API接口获取淘宝商品数据的步骤。1.注册账号并创建应用首先,我们需要进行账号注册、实名认证和创建应用。通过创建应用,我们可以获取到一个appkey和appsecret,这是调用API接......
  • 速存,详细罗列香橙派AIpro外设接口样例大全(附源码)
    本文分享自华为云社区《香橙派AIpro外设接口样例大全(附源码)》,作者:昇腾CANN。OrangePiAIPro开发板是香橙派联合华为精心打造的高性能AI开发板,其搭载了昇腾AI处理器,可提供8TOPSINT8的计算能力,内存提供了8GB和16GB两种版本。可以实现图像、视频等多种数据分析与推理计......
  • 【实战技能】简单易实现的SWD接口烧录目标板挂载的EEPROM,支持AT24C02/04/08/16/32/64/
    之前针对外部SPIFlash的SWD接口烧写,制作过一期专题视频教程。产品生产时,不仅SPIFlash,有时候希望烧录目标板程序后,将EERPOM里面的参数也通过SWD接口存储进去,这样就不再需要大家单独再接上EEPROM的I2C接口烧录了,产品生产比较省事。针对这个问题就花了些时间,制作了下EEPROM的烧写......
  • RAG实战3-如何追踪哪些文档片段被用于检索增强生成
    RAG实战3-如何追踪哪些文档片段被用于检索增强生成本文是RAG实战2-如何使用LlamaIndex存储和读取embedding向量的续集,在阅读本文之前请先阅读前篇。在前篇中,我们介绍了如何使用LlamaIndex存储和读取embedding向量。在本文中,我们将介绍在LlamaIndex中如何获得被用于检索增强生成......