除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站

开头先声明,这不是广告,不是广告,不是广告,没有恰饭。

本人在公司开发的时候,由于使用的框架还是SSM,对接Swagger相当麻烦,但又不能不写接口文档吧?所以只能跑去问问度娘了。

我:“度娘度娘,谁是这世界上最好用的接口文档呢?”

度娘:“那当然是ShowDoc啦!”

这个接口文档网站是我无意间发现的,真的巨好用,注册简单,使用方便,重要的是还免费,这上哪找去?缺点就是纯手写,不过短期应付也还好,对于懒的兄弟,也有模板提供,没有用Swagger的兄弟应付应付前端也还是可以的(手动狗头,前端兄弟开个玩笑)

废话不多说,进入正题:

1.进入网址

官方地址:https://www.showdoc.cc/
首先肯定是要注册的,只需要邮箱即可。
注册完成登录后,右上角有一个我的项目,点击即可达到我的项目页面。
除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站

2.我的项目

进入到我的项目页面,就可以创建自己的项目了,前3个是自带的,最后一个叫qs的项目就是我自己创建的了
除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站

3.新建项目

这里就不用我多说了吧?
除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站

4.新建项目的团队

项目建好后,就可以把你们项目组的人都拉进来了,前提是他们先要注册好。

1.点击团队管理
除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站
2.就可以看到我的团队了,然后添加团队
除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站
3.点击某个团队的成员,就可以添加成员了,把自己的同事都拉进来吧。不过好像是有上限的,我忘记是几个了,不过拉开发人员应该足够了
除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站

5.为团队分配一个项目

把刚刚新建的团队分配一个项目,那么该团队的人都可以看到这个项目了
在团队管理页面,点击项目就可以进入这个界面了
除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站

6.新建一个接口文档

回到我的项目页面,点击该项目,就可以进到项目的文档页了除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站
然后点击新建文档,可以选择该文档的目录,然后接口文档的模板就是点击插入API接口模板即可,然后就可以开始写文档啦
除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站
该接口文档的教程就到此了,感谢大家的观看,应该没有什么难懂的地方吧?

本人第一篇文章,处女作,有写的不好地方还望各位口下别留情面,使劲喷就完事了,接受批评,希望后面越来越好。

作者公众号(欢迎关注,分享的全是干货!!!):
除了自动生成的Swagger,还有手动免费且巨好用的手写接口文档网站