搭建showdoc+RunApi接入

前言

开发过程中如果是用代码生成接口文档，会有一定的耦合性，所以选择用showdoc，自己搭建showdoc服务，自己用自己的接口文档，然后用RunAPi调试接口，可以生成markdown接口和代码，如果接口或者文档有变动，也在RunAPI中修改。
showdoc在服务器中运行，RunApi本地连接服务器的showdoc，实时修改同步

服务器配置

服务器建议centos7,稳定，如果服务器新的，建议用oneinstack一键配置 安装所需环境，基本环境在官方文档中有说明，建议nginx+php7.1，php版本太低不兼容太高也不兼容

相关官方文档及源码

showdoc官网
showdoc帮助说明
showdoc源码
RunApi源码

源码安装

站点根目录下执行
git clone https://gitee.com/star7th/showdoc.git
给个权限，避免安装过程中没权限
chmod -R 777 showdoc

0.png

showdoc+runapi使用

1.png

2.png

3.png

4.png

5.png

6.png

7.png

8.png

9.png

10.png

11.png

12.png

13.png

14.png

15.png

16.png

17.png

18.png

19.png

20.png

21.png

22.png

23.png

24.png

image.png

总结

到这里，showdoc和runapi的简单使用就完成了。
配合团队开发使用效果不错，就是权限上有点略微不足，但是小型开发团队使用完全没问题的。
开发过程中搭配接口文档记录，开发规范环境配置等都可以直接写好，项目完结了还可以导出文档.
最后重点！这种风格文档对前端开发人员很友好，字段说明清晰，如果是后台使用注解生成的文档，比如Swagger ，那么恭喜，如果开发人员书写不规范，前端都不知道这请求参数和返回值都是些啥，只能说是各有优点吧，看项目负责人安排。