# mini-knife4j

**Repository Path**: ssoss/mini-knife4j

## Basic Information

- **Project Name**: mini-knife4j
- **Description**: 微服务、网关gateway与knife4j、swagger整合与优化
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-07-09
- **Last Updated**: 2024-04-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mini-knife4j

#### 介绍

微服务、网关gateway与knife4j、swagger整合优化

更友好支持与方便前后端接口联调、后端开发自测，提升效率，拒绝内卷

#### 软件安装

1.nacos server

2.mysql (可选，如不需要，可以注释掉相关注解和代码)

#### 软件架构

1.knife4j改造

2.swagger

3.微服务与网关gateway


#### 项目结构

mini-api：接口调用

mini-gateway：网关

mini-module：存放自定义starter, 这里主要看mini-swagger-knife4j，就可以了

mini-service：该目录下有order和user服务


#### 使用说明

1.启动nacos server、mysql


2.微服务项目引入（若是使用当前项目，已经引入下面的依赖了）

```
  <dependency>
    <groupId>com.mini</groupId>
    <artifactId>mini-swagger-knife4j</artifactId>
    <version>1.0-SNAPSHOT</version>
  </dependency>

```

3.直接启动项目即可

4.启动后，访问微服务接口，url：http://ip:port/应用上下文/doc.html

若无上下文，则url: http://ip:port/doc.html

![输入图片说明](imagesimage.png)

5.若是网关接入，可以拷贝本项目网关的swagger目录下的代码(可优化：自定义成springStarter，作为依赖，引入到网关的pom.xml)

6.网关启动后，若是通过网关访问所有的微服务接口，url：http://ip:port/doc.html

![输入图片说明](imagesimage.png)