0

0

Swagger文档在Debian的生成方法

月夜之吻

月夜之吻

发布时间:2025-06-13 09:26:33

|

361人浏览过

|

来源于php中文网

原创

在debian系统上生成openapi规范(曾被称为swagger)文档,通常会结合spring boot框架进行开发与接口文档化。以下是完整的操作流程:

  1. 安装Java和Maven: 确保你的Debian系统中已安装Java和Maven。如果尚未安装,可以使用以下命令进行安装:

    <code> sudo apt update
     sudo apt install openjdk-11-jdk maven</code>
  2. 创建Spring Boot项目: 使用Spring Initializr来生成一个新的Spring Boot项目。选择你需要的依赖项(例如Spring Web),然后下载项目压缩包。

  3. 解压并导入IDE: 将下载的项目解压至本地目录,并通过你常用的开发工具(如IntelliJ IDEA或Eclipse)导入该项目。

  4. 添加Swagger依赖: 打开项目的pom.xml文件,并加入以下Swagger相关的依赖配置:

    <code> <dependencies><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></code>

    请根据当前使用的Spring Boot版本适当调整版本号,以确保兼容性。

  5. 配置Swagger功能: 创建一个用于启用和配置Swagger的类文件。在src/main/java/com/yourpackage路径下新建名为SwaggerConfig.java的配置类:

    Kuwebs企业网站管理系统3.1.5 UTF8
    Kuwebs企业网站管理系统3.1.5 UTF8

    酷纬企业网站管理系统Kuwebs是酷纬信息开发的为企业网站提供解决方案而开发的营销型网站系统。在线留言模块、常见问题模块、友情链接模块。前台采用DIV+CSS,遵循SEO标准。 1.支持中文、英文两种版本,后台可以在不同的环境下编辑中英文。 3.程序和界面分离,提供通用的PHP标准语法字段供前台调用,可以为不同的页面设置不同的风格。 5.支持google地图生成、自定义标题、自定义关键词、自定义描

    下载
    <code> package com.yourpackage;
    
     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
     @EnableSwagger2
     public class SwaggerConfig {
    
         @Bean
         public Docket api() {
             return new Docket(DocumentationType.SWAGGER_2)
                     .select()
                     .apis(RequestHandlerSelectors.basePackage("com.yourpackage")) // 修改为你自己的Controller所在包路径
                     .paths(PathSelectors.any())
                     .build();
         }
     }</code>
  6. 启动Spring Boot应用: 在IDE内运行该Spring Boot程序,或者通过终端执行如下Maven命令启动:

    <code> mvn spring-boot:run</code>
  7. 访问Swagger UI界面: 应用启动完成后,在浏览器输入以下地址访问Swagger UI页面:

    <code> http://localhost:8080/swagger-ui.html</code>

    此时你应该能看到展示所有API信息的图形化界面。

  8. 添加API描述注解: 在控制器类中引入适当的Swagger注解,从而增强接口说明。示例代码如下:

    <code> package com.yourpackage.controller;
    
     import io.swagger.annotations.Api;
     import io.swagger.annotations.ApiOperation;
     import org.springframework.web.bind.annotation.GetMapping;
     import org.springframework.web.bind.annotation.RequestMapping;
     import org.springframework.web.bind.annotation.RestController;
    
     @RestController
     @RequestMapping("/api")
     @Api(tags = "示例控制器")
     public class ExampleController {
    
         @GetMapping("/hello")
         @ApiOperation(value = "返回Hello World", notes = "根据用户ID获取用户信息")
         public String sayHello() {
             return "Hello, World!";
         }
     }</code>
  9. 刷新查看更新内容: 每次修改完Swagger相关配置或添加新的注解后,重新启动服务并在浏览器刷新Swagger UI页面以便查看最新文档。

按照上述步骤操作,即可顺利地在基于Debian的操作系统上完成Spring Boot与Swagger集成,并利用其强大的UI功能对API进行可视化管理和测试。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

150

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

88

2026.01.26

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

138

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

408

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

73

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

139

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

268

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

31

2026.02.11

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

33

2026.03.04

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Rust 教程
Rust 教程

共28课时 | 6.6万人学习

PostgreSQL 教程
PostgreSQL 教程

共48课时 | 10.1万人学习

Git 教程
Git 教程

共21课时 | 4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号