广告
返回顶部
首页 > 资讯 > 后端开发 > Python >Spring项目中swagger用法与swagger-ui使用
  • 858
分享到

Spring项目中swagger用法与swagger-ui使用

2024-04-02 19:04:59 858人浏览 安东尼

Python 官方文档:入门教程 => 点击学习

摘要

目录一、swagger用法 1.1、编写SpringBoot项目1.2、导入spring-fox依赖1.3、添加注解1.4、访问swagger-ui二、swagger-ui

一、swagger用法

 1.1、编写springboot项目

在这里插入图片描述


package com.xbmu.controller;

import com.xbmu.bean.Person;
import org.springframework.WEB.bind.annotation.*;

import java.util.ArrayList;
import java.util.List;

@RestController
@RequestMapping(value = "/person")
public class PersonController {
    @PostMapping("/postReq")
    public String postReq()
    {
        return "postReq";
    }
    @GetMapping("/getReq")
    public String getReq(String param1,String param2)
    {
        return "getReq";
    }
    @RequestMapping("/req")
    public String req(String param1)
    {
        return "req";
    }

    @RequestMapping(value = "/getPersonSingle",method = RequestMethod.GET)
    private Person getPersonSingle(Integer id){
        Person person;
        List<Person> personList = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            person = new Person();
            person.setId(i+1);
            person.setName("zhangsan"+(i+1));
            person.setGender("男"+i);
            person.setAge(18+1);
            person.setAddress("shanxi xian");
            personList.add(person);
        }
        person = personList.get(id);
        return person;
    }
}

1.2、导入spring-fox依赖

在项目pom.xml中导入spring-fox依赖,该项目选择版本为2.9.2。其中springfox-swagger2是核心内容的封装。springfox-swagger-ui是对swagger-ui的封装。


<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="Http://Maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.xbmu</groupId>
    <artifactId>swagger-study</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.2.5.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
    </dependencies>

</project>

1.3、添加注解

在springboot的启动类中添加 @EnableSwagger2 注解。
添加此注解后表示对当前项目中全部控制器进行扫描。应用swagger2。


package com.xbmu;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableSwagger2
public class MyApp {
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class,args);
    }
}

1.4、访问swagger-ui

启动项目后在浏览器中输入 http://ip:port/swagger-ui.html 既可以访问到swagger-ui页面,在页面中可以可视化的进行操作项目中所有接口。

二、swagger-ui使用

访问swagger-ui.html后面可以在页面中看到所有需要生成接口文档的额控制器名称。

在这里插入图片描述

每个控制器中包含多个所有控制器方法的各种访问方式。如果使用的是@RequestMapping进行映射,将显示下面的所有请求方式。如果使用@PostMapping将只有post方式可以能访问,下面也就只显示post的一个。

在这里插入图片描述

点击某个请求方式中 try it out

在这里插入图片描述

会出现界面要求输入的值。输入完成后点击Execute按钮

在这里插入图片描述

以上就是Spring项目中swagger用法与swagger-ui使用的详细内容,更多关于swagger用法与swagger-ui使用的资料请关注编程网其它相关文章!

--结束END--

本文标题: Spring项目中swagger用法与swagger-ui使用

本文链接: https://www.lsjlt.com/news/126884.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • Spring项目中swagger用法与swagger-ui使用
    目录一、swagger用法 1.1、编写springboot项目1.2、导入spring-fox依赖1.3、添加注解1.4、访问swagger-ui二、swagger-ui...
    99+
    2022-11-12
  • SpringBoot项目集成Swagger和swagger-bootstrap-ui及常用注解解读
    目录一、前言二、SpringBoot项目集成swagger1. 引入依赖2. 编写配置文件3. 启动访问页面三、SpringBoot项目集成swagger-bootstrap-ui1...
    99+
    2023-05-14
    SpringBoot项目集成Swagger SpringBoot项目集成swagger-bootstrap-ui SpringBoot常用注解
  • SpringBoot项目集成Swagger和swagger-bootstrap-ui及常用注解有哪些
    本篇内容介绍了“SpringBoot项目集成Swagger和swagger-bootstrap-ui及常用注解有哪些”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔...
    99+
    2023-07-05
  • springboot项目中怎么使用Swagger
    今天小编给大家分享一下springboot项目中怎么使用Swagger的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。1、Sw...
    99+
    2023-07-05
  • 如何在springboot项目中使用 swagger
    这篇文章将为大家详细讲解有关如何在springboot项目中使用 swagger,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。1、pom.xml引入了两个jar。<dependency...
    99+
    2023-05-31
    swagger springboot
  • 在SpringBoot项目中的使用Swagger的方法示例
    目录一. 首先Swagger是什么?Swagger的主见介绍:二. Swagger UI的使用:三. Swagger整合SpringBoot1. Pom依赖:2. 配置类:3...
    99+
    2022-11-12
  • Spring Boot中怎么使用Swagger
    小编给大家分享一下Spring Boot中怎么使用Swagger,希望大家阅读完这篇文章之后都有所收获,下面让我们一起去探讨吧!Swagger 简介Swagger 是一个方便 API 开发的框架,它有以下优点:自动生成在线文档,后端开发人员...
    99+
    2023-06-20
  • springboot项目中使用Swagger的简单示例
    目录1、Swagger是啥2、Swagger有什么用?3、springboot中如何引入Swagger4、项目的总体结构5、通过网址访问网页总结 1、Swagger是啥 S...
    99+
    2023-05-14
    springboot使用swagger springboot swagger
  • Node.js项目中如何使用Koa2集成Swagger
    这篇“Node.js项目中如何使用Koa2集成Swagger”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“Node.js项目...
    99+
    2023-07-05
  • .NET Core项目使用swagger开发组件
    首先我创建一个。net core项目,我使用的工具是vs2019 这里需要注意的是,看情况选择是否开启身份验证,一般是没有需求的,这里因为我是测试使用所以需要取消勾兑为https配...
    99+
    2022-11-13
  • Spring Boot中如何使用Swagger详解
    目录Swagger 简介 配置 Swagger 添加依赖为项目开启 Swagger创建 SwaggerConfig 配置类访问 Swagger 前端页面控制器相关注解实体相关注解总结...
    99+
    2022-11-12
  • 一文探讨Node.js项目中怎么使用Koa2集成Swagger
    以上就是一文探讨Node.js项目中怎么使用Koa2集成Swagger的详细内容,更多请关注编程网其它相关文章!...
    99+
    2023-05-14
    Node.js 前端 测试
  • SpringBoot中使用Swagger的超简单方法
    Swagger号称世界上最流行的Api框架,它是RestFul 风格的Api。文档在线自动生成工具:Api文档与API定义同步更新。可以直接运行,能在线测试API接口;支持多种编程语...
    99+
    2022-11-12
  • 如何在Spring与Spring Boot项目中使用Dubbo
    这篇文章给大家介绍如何在Spring与Spring Boot项目中使用Dubbo,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。一、在Spring中使用Dubbo1、Maven依赖<dependency>&n...
    99+
    2023-05-30
    spring spring boot dubbo
  • spring项目中切面及AOP的使用方法
    使用AOP的原因(AOP简介) 我们知道,spring两大核心,IOC(控制反转)和AOP(切面),那为什么要使用AOP,AOP是什么呢,严格来说,AOP是一种编程规范,是一种编程思...
    99+
    2022-11-12
  • Mysql数据库与JPA如何在Spring Boot项目中使用
    本篇文章为大家展示了Mysql数据库与JPA如何在Spring Boot项目中使用,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。1.Maven pom.xml文件在你的项目中增加如下依赖文件<...
    99+
    2023-05-31
    springboot jpa mysql
  • freemarker如何在Spring Boot项目中使用
    今天就跟大家聊聊有关freemarker如何在Spring Boot项目中使用,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。(1) freemarker介绍;FreeMarker是一...
    99+
    2023-05-31
    springboot freemarker
  • Spring AOP如何在java项目中使用
    这篇文章将为大家详细讲解有关Spring AOP如何在java项目中使用 ,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。一、什么是AOP  AOP(Aspect Oriented ...
    99+
    2023-05-31
    java spring aop ava
  • 如何在Spring项目中正确使用Git?
    Spring是一个非常流行的Java框架,它帮助开发人员更快地构建Java应用程序。Git是一种分布式版本控制系统,它可以帮助开发人员更好地管理代码。在Spring项目中正确使用Git是非常重要的,本文将介绍如何在Spring项目中正确使用...
    99+
    2023-10-11
    apache spring git
  • Spring MVC项目中log4J和AOP使用详解
    前言日志处理是每个项目当中一个非常重要的内容。没有了日志,也就失去了对系统的可控性。没有日志,系统出现任何问题,都会没有踪迹可寻,这对一个信息系统而言是非常危险的。项目中需要将service中的类方法的调用过程,使用log4j日志记录。se...
    99+
    2023-05-30
    springmvc aop log4j
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作