SpringBoot-7. 使用Swagger构建文档

swagger可以降低我们前后端开发文档同步问题,其能够根据我们的代码注释自动生成API文档,而我们只需简单的运用其注释即可,可视化的呈现程序所有的接口列表,非常方便我们前后端进行接口调试。

The Best APIs are Built with Swagger Tools

Swagger工具可以帮助您完成生成和维护API文档的工作,确保您的文档在API发展过程中保持最新状态。

1. 添加Swagger依赖

<!-- swagger -->
<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>

2. 新建SwaggerConfig类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfo(
                "Spring Boot Swagger Test",
                "我的博客网站:https://zyz-1998.github.io/,欢迎大家访问。",
                "API V1.0",
                "Terms of service",
                new Contact("zyz", "https://zyz-1998.github.io/", "1744020412@qq.com"),
                "Apache", "http://www.apache.org/", Collections.emptyList());
    }
}

3. 添加文档内容

用于Controller(控制类)

注解作用
@Api表示一个开放的API
@ApiOperation给API增加说明,表示针对该API的CRUD操作
@ApiResponses描述API操作可能出现的异常情况
@ApiImplicitParams@ApiImplicitParam给API参数增加说明。

用于model(实体类)

注解作用
@ApiModel注解实体
@ApiModelProperty定义实体属性

4. 访问验证

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

效果如下:

在这里插入图片描述

基于开源大模型的教学实训智能体软件,帮助教师生成课前备课设计、课后检测问答,提升效率与效果,提供学生全时在线练习与指导,实现教学相长。 智能教学辅助系统 这是一个智能教学辅助系统的前端项目,基于 Vue3+TypeScript 开发,使用 Ant Design Vue 作为 UI 组件库。 功能模块 用户模块 登录/注册功能,支持学生和教师角色 毛玻璃效果的登录界面 教师模块 备课与设计:根据课程大纲自动设计教学内容 考核内容生成:自动生成多样化考核题目及参考答案 学情数据分析:自动化检测学生答案,提供数据分析 学生模块 在线学习助手:结合教学内容解答问题 实时练习评测助手:生成随练题目并纠错 管理模块 用户管理:管理员/教师/学生等用户基本管理 课件资源管理:按学科列表管理教师备课资源 大屏概览:使用统计、效率指数、学习效果等 技术栈 Vue3 TypeScript Pinia 状态管理 Ant Design Vue 组件库 Axios 请求库 ByteMD 编辑器 ECharts 图表库 Monaco 编辑器 双主题支持(专业科技风/暗黑风) 开发指南 # 安装依赖 npm install # 启动开发服务器 npm run dev # 构建生产版本 npm run build 简介 本项目旨在开发一个基于开源大模型的教学实训智能体软件,帮助教师生成课前备课设计、课后检测问答,提升效率与效果,提供学生全时在线练习与指导,实现教学相长。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值