Giter Club home page Giter Club logo

yapix's Introduction

Yapi X

👏👏👏 本项目已收录到YApi, Rap2官方仓库

一键生成API接口文档, 上传到YApi, Rap2, Eolinker等平台的IDEA插件.

🐮 亮点

  • 零成本、零入侵: 编写标准Javadoc即可,无需依赖swagger注解, 生成API文档准确性高达99%。
  • 开箱即用、智能mock规则: 几乎零配置直接可生成文档,也支持复杂配置满足你95%的场景。
  • 多平台支持:支持YApi, Rap2, Eolinker等,并支持账户密码登录

🐱 特性

  • 一键从源代码生成api文档
  • 上传到YApi平台
  • 上传到Rap2平台
  • 上传到Eolinker平台
  • 上传到ShowDoc平台
  • 导出markdown文件
  • 复制为cURL命令

使用

  1. 安装: 打开Idea -> File -> Settings -> Plugins, 搜索: Yapi X
  2. 配置: 项目根目录创建".yapix"文件, 内容: yapiProjectId=110
  3. 上传: 光标放置在你的控制类或方法,右键执行: Upload To YApi ( 提示:如果未填登录信息,会弹窗提示 )

更多:十分钟使用指南

交流

欢迎提出您的发现问题、需求、建议、以及提交代码来参与贡献。

提示:如果您准备为该插件开发一个新功能,请先通过issues讨论,避免重复开发。

捐赠

非常感谢您使用Yapi X,如果贵公司有非通用的定制开发需求,可提供有偿定制开发服务。

谁在使用

wxb

yapix's People

Contributors

lkqm avatar

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.