码界工坊

htykm.cn
人生若只如初见

Debian下Swagger与Spring Boot如何集成

在Debian系统下集成Swagger与Spring Boot,可以按照以下步骤进行:

1. 创建Spring Boot项目

首先,你需要创建一个Spring Boot项目。你可以使用Spring Initializr来快速生成项目结构。

  1. 访问 Spring Initializr。
  2. 配置项目:
    • Group: 例如 com.example
    • Artifact: 例如 swagger-demo
    • Name: 例如 swagger-demo
    • Description: 例如 Demo project for Swagger with Spring Boot
    • Package name: 例如 com.example.swaggerdemo
    • Packaging: 选择 Jar
    • Java: 选择你使用的Java版本,例如 1117
  3. 添加依赖:
    • Spring Web
    • Springfox Swagger2
    • Springfox Swagger UI
  4. 点击 Generate下载项目压缩包。
  5. 解压项目并导入到你的IDE中(例如IntelliJ IDEA或Eclipse)。

2. 配置Swagger

在Spring Boot项目中配置Swagger,需要创建一个配置类。

  1. src/main/java/com/example/swaggerdemo目录下创建一个新的Java类,例如 SwaggerConfig.java
  2. 添加以下代码:
package com.example.swaggerdemo;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfig {     @Bean    public Docket api() {         return new Docket(DocumentationType.SWAGGER_2)                .select()                .apis(RequestHandlerSelectors.basePackage("com.example.swaggerdemo.controller"))                .paths(PathSelectors.any())                .build();    }}

3. 创建控制器

创建一个简单的控制器来测试Swagger。

  1. src/main/java/com/example/swaggerdemo/controller目录下创建一个新的Java类,例如 HelloController.java
  2. 添加以下代码:
package com.example.swaggerdemo.controller;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;@RestController@RequestMapping("/api")public class HelloController {     @GetMapping("/hello")    public String sayHello() {         return "Hello, Swagger!";    }}

4. 运行项目

在终端中运行Spring Boot应用程序。

cd /path/to/swagger-demo./mvnw spring-boot:run

5. 访问Swagger UI

打开浏览器并访问以下URL:

http://localhost:8080/swagger-ui.html

你应该能够看到Swagger UI界面,并且可以看到你创建的API文档。

6. 配置安全设置(可选)

如果你有安全设置(例如Spring Security),你可能需要配置Swagger UI的访问权限。

  1. SecurityConfig.java中添加以下代码:
package com.example.swaggerdemo;import org.springframework.context.annotation.Configuration;import org.springframework.security.config.annotation.web.builders.HttpSecurity;import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;@Configuration@EnableWebSecuritypublic class SecurityConfig extends WebSecurityConfigurerAdapter {     @Override    protected void configure(HttpSecurity http) throws Exception {         http.authorizeRequests()                .antMatchers("/swagger-ui.html", "/webjars/**", "/swagger-resources/**").permitAll()                .anyRequest().authenticated()                .and()                .formLogin()                .and()                .httpBasic();    }}

这样,Swagger UI和相关的静态资源就可以被公开访问了。

通过以上步骤,你就可以在Debian系统下成功集成Swagger与Spring Boot。

未经允许不得转载 » 本文链接:http://htykm.cn/html/637c699356.html

推荐文章

  • 如何优化Debian上Rust的内存使用

    在Debian上优化Rust程序的内存使用,可以从多个方面入手。以下是一些常见的方法和最佳实践:1. 选择合适的数据结构使用VecDeque代替Vec:如果你需要频繁地在两端插入或删除元素,VecDe ...

  • Debian JSP如何优化代码结构

    在Debian系统上进行JSP代码优化,可以遵循以下策略来提高代码的可维护性、可读性和性能:代码压缩与优化压缩HTML、CSS和JavaScript:删除无用的HTML注释、空格、换行符,利用工具自动 ...

  • Ubuntu中如何解决PHP错误

    在Ubuntu系统中解决PHP错误,可以遵循以下步骤:确认错误信息:首先,需要了解具体的PHP错误信息。错误信息通常会在浏览器中显示,或者在命令行中运行PHP脚本时显示。查看错误日志:PHP错误日志通 ...

  • Jenkins在Debian上如何实现多分支构建

    在Debian上使用Jenkins实现多分支构建,可以通过以下步骤来完成:1. 安装Jenkins首先,确保你已经在Debian系统上安装了Jenkins。如果还没有安装,可以按照以下步骤进行:# 更 ...

  • Debian系统Filebeat启动失败怎么办

    当在Debian系统上安装的Filebeat启动失败时,可以按照以下步骤进行排查和解决:检查Filebeat日志首先,查看Filebeat的日志文件,以了解详细的错误信息。日志文件通常位于 /var/ ...

  • centos系统phpstorm插件推荐

    在CentOS系统上使用PhpStorm时,以下是一些推荐的插件,它们可以提升开发效率和代码质量:PHP Inspections (EA Extended):扩展的PHP代码检查和警告,帮助开发者编写 ...

  • 如何自定义Tomcat日志格式

    自定义Tomcat日志格式可以通过修改配置文件来实现。以下是具体的步骤:1. 修改 server.xml文件在 server.xml文件中,找到 Valve元素,其 className属性为 org. ...

  • centos分卷有哪些高级功能

    CentOS 分卷具有以下高级功能:动态管理:LVM逻辑卷管理)允许管理员动态调整逻辑卷的大小,操作简单且不损坏已存储的数据。这使得系统能够根据实际需求灵活分配存储空间。扩展性:通过 LVM,可以轻松 ...