Giter Club home page Giter Club logo

cocodoc's Introduction

CocoDoc 接口文档IDEA导出插件

主要用于提高团队开发中后端与前端之间的沟通效率,一键生成对应的Rest接口文档,达到快速交付的目的。

功能说明

使用场景

团队中前端与后端沟通所需文档,无需编译和启动,安装轻松,无需费时编写文档

Image text

Image text

操作流程

直接下载代码根目录中的插件包CocoDoc.zip 或者 下载代码自己build插件包

打开IDEA,选择【File】--- 【Settings】---【Plugins】

Image text

Image text

点击齿轮图标,选择【Install Plugin from Disk】

Image text

选择刚才下载的CocoDoc.zip插件包

Image text

安装之后 重启IDEA

Image text

多粒度使用

多种粒度可以导出Rest文档

1.单个方法导出

例如选择【soms-tenant-rest】模块-【AllotRest类】--【queryPage方法】

注意:导出单个方法一定要选中方法名

Image text

然后选择菜单栏中【Tools】--【CocoDoc文档生成工具】

Image text

弹出的窗口中点击【生成文档】按钮

Image text

Image text

生成的文档会放在桌面,名称为 CocoDoc接口文档.doc

我们打开word文档查看导出结果:

Image text

文件中可以点击左侧的目录进入寻址查看

Image text

2.单个类导出

单个类导出需要选中rest类

Image text

后续的步骤相同

效果如下图:

Image text

3.整个包或整个模块导出

这个如果选定的目录内文件太多,可能写文件太费时间。

选中整个模块,比如【soms-tenant-rest】模块

Image text

后续步骤相同

cocodoc's People

Contributors

zhangjunwu123 avatar

Stargazers

 avatar  avatar  avatar

Watchers

James Cloos avatar  avatar

Forkers

kimguo1993

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.