这篇博客针对苍穹外卖而写
YApi
之前的官网:yapi.smart-xwork.cn
由于之前的网址访问不了,现在我用的是这个网址:YApi Pro-高效、易用、功能强大的可视化接口管理平台
登录之后如下
创建两个工作空间
用户端接口也是如法炮制
Swagger
使用Swagger你只需要按照它的规范去定义接口及接口相关的信息,就可以做到生成接口文档,以及在线接口调试页面。
官网:https://swagger.io/
Knife4j 是为Java MVC框架集成Swagger生成Api文档的增强解决方案。
pom.xml
Swagger做标
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
在配置类中加上这个注解
@Slf4j
这里写这两个方法
最后开启项目,访问http://localhost:8080/doc.html