码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift
  • Swager如何使用


    Swager是一个API文档自动生成工具,可以用于生成API接口文档,供开发者和用户查看和使用。它可以通过描述API接口的规范,自动生成API文档,使得API接口的发布和使用变得更加简单和规范。

    下面是使用Swagger的步骤:

    1. 首先,在你的项目中添加Swagger依赖。如果你是使用Maven构建项目,可以在pom.xml文件中添加以下依赖:
    1. <dependency>
    2. <groupId>io.springfox</groupId>
    3. <artifactId>springfox-swagger2</artifactId>
    4. <version>2.9.2</version>
    5. </dependency>
    6. <dependency>
    7. <groupId>io.springfox</groupId>
    8. <artifactId>springfox-swagger-ui</artifactId>
    9. <version>2.9.2</version>
    10. </dependency>
    1. 然后,配置Swagger。在Spring Boot项目中,你可以创建一个Swagger配置类来配置Swagger。例如:
    1. @Configuration
    2. @EnableSwagger2
    3. public class SwaggerConfig {
    4. @Bean
    5. public Docket api() {
    6. return new Docket(DocumentationType.SWAGGER_2)
    7. .select()
    8. .apis(RequestHandlerSelectors.any())
    9. .paths(PathSelectors.any())
    10. .build();
    11. }
    12. }
    1. 在API接口类中添加Swagger注解。例如:
    1. @RestController
    2. @RequestMapping("/users")
    3. @Api(value = "users", description = "Operations for users")
    4. public class UserController {
    5. @GetMapping("/{id}")
    6. @ApiOperation(value = "Get user by id", response = User.class)
    7. public User getUserById(@PathVariable Long id) {
    8. // your code here
    9. }
    10. }
    1. 最后,访问Swagger UI界面,查看生成的API文档。默认情况下,Swagger UI界面可以通过访问http://localhost:8080/swagger-ui.html来访问。

    以上就是使用Swagger的基本步骤,你可以根据项目的需求进行定制化配置。

  • 相关阅读:
    「学习笔记」组合计数与中国剩余定理
    基于Vite创建一个Vue2项目
    关于异或的小疑惑
    Java----内部类、外部类、匿名对象、匿名对象的创建
    基础 | JVM - [内存模型 & JMM]
    SpringMVC(5)——拦截器
    HTML+CSS+JS网页设计期末课程大作业 DW个人博客网站制作 web前端开发技术 web课程设计 网页规划与设计
    SpringBoot自动装配原理及分析
    .NET 6学习笔记(2)——通过Worker Service创建Windows Service
    Windows10更新CUDA
  • 原文地址:https://blog.csdn.net/Stephen_CY666/article/details/133936512
  • 最新文章
  • 沪漂五周年了:我越来越迷茫了
    Agentic Skill Routing 实战:别再把所有 Skill 塞进 AI Agent 上下文
    MySQL-Seconds_behind_master的精度误差
    [MAF预定义ChatClient中间件-03]CachingChatClient——利用缓存省钱省时间
    AI的至暗历史:从万众期待到被政府撤资,AI的两次死亡徘徊
    Agent OS :五种驯服不确定性的范式
    PortSwigger SQL注入LAB11
    数据库即时编译JIT
    [Begin]AI Learn Data Day 0
    深度学习进阶(二十七)现代 LLM 的核心架构设计其二:SwiGLU
  • 热门文章
  • 十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧!!!
    奉劝各位学弟学妹们,该打造你的技术影响力了!
    五年了,我在 CSDN 的两个一百万。
    Java俄罗斯方块,老程序员花了一个周末,连接中学年代!
    面试官都震惊,你这网络基础可以啊!
    你真的会用百度吗?我不信 — 那些不为人知的搜索引擎语法
    心情不好的时候,用 Python 画棵樱花树送给自己吧
    通宵一晚做出来的一款类似CS的第一人称射击游戏Demo!原来做游戏也不是很难,连憨憨学妹都学会了!
    13 万字 C 语言从入门到精通保姆级教程2021 年版
    10行代码集2000张美女图,Python爬虫120例,再上征途
小工具 小游戏
Copyright © 2022 侵权请联系2656653265@qq.com    京ICP备2022015340号-1

京公网安备 11010502049817号