2021-10-03

酒店信息管理项目——之swagger 接口文档

这个项目是本人在工作之余利用闲暇时间进行开发的，主要是为了弥补大学毕业设计的遗憾（本人并不是没有过^_,只是没有做自己喜欢的毕业设计）。酒店信息管理系统是一个前后端分离项目，前端使用vue,后端使用java开发，开发完后部署在云服务器上。
废话少说直接上项目地址，http://121.43.170.105:8004
账号：black 密码：root (也可以自行注册)
如果有不明白可以看我的主页关于酒店信息管理项目系列的文章

---

前言

有需要代码的小伙伴私信我WX: 1208191350

---

一、项目结构和技术栈的使用

项目的整体结构采用的是前后端分离的形式：
后端框架的使用：spring-boot maven mybatis-plus mybatisX
后端技术栈的使用：
1.JWT令牌权限校验与授权登录
2.短信验证码登录，使用阿里云短信服务
3.swagger api接口文档生成器
4.mybatis-plus-generator 代码生成
5.七牛云图片上传服务，将图片保存到三方服务器
6.结合数据库使用spring-boot的定时调度任务
7.redis进行短信验证码的验证，和JWT令牌（Token）的激活（保活）
后台项目结构：

前端框架的使用：vue-cli3 element-ui vue-router
前端技术栈的使用：html css scss js vue axsio
前端项目结构：

二、功能介绍

1.swagger 接口文档

接口文档地址：http://121.43.170.105:8080/swagger-ui.html

1.1导入所需要的依赖包：

<!-- 导入swagger依赖包 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.5.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.5.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-staticdocs</artifactId>
            <version>2.5.0</version>
        </dependency>

1.2导入配置类：

package com.hotel.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration // 标明是配置类
@EnableSwagger2 //开启swagger功能
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)  // DocumentationType.SWAGGER_2 固定的，代表swagger2
//                .groupName("分布式任务系统") // 如果配置多个文档的时候，那么需要配置groupName来分组标识
                .apiInfo(apiInfo()) // 用于生成API信息
                .select() // select()函数返回一个ApiSelectorBuilder实例,用来控制接口被swagger做成文档
                .apis(RequestHandlerSelectors.basePackage("com.hotel.controller")) // 用于指定扫描哪个包下的接口
                .paths(PathSelectors.any())// 选择所有的API,如果你想只为部分API生成文档，可以配置这里
                .build();
    }

    /**
     * 用于定义API主界面的信息，比如可以声明所有的API的总标题、描述、版本
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("如家酒店管理系统API") //  可以用来自定义API的主标题
                .description("如家酒店管理系统SwaggerAPI管理") // 可以用来描述整体的API
                .termsOfServiceUrl("") // 用于定义服务的域名
                .version("1.0") // 可以用来定义版本。
                .build(); //
    }
}