Git Product home page Git Product logo

intelligent-api-platform's Introduction

intelligent-api-platform

项目介绍

智能的api平台,提供根据项目自动生成接口文档(只支持java项目),自动生成json格式数据,便于做自测/测试,可以对接口直接进行测试,模拟http请求,自定义cookie,header信息。

PPT

详细见项目/doc路径

软件架构

文档架构简要图

当我们开发过程中,通过给代码加注解,然后通过 mvn clean install -P generate-doc,在编译期通过解析class生成doc树,并将doc树通过http请求,发送到itapm系统后台,通过itapm-web展示。

安装教程

  1. 拉代码到本地。
  2. 初始化config/init.sql到mysql数据库。
  3. 配置mysql信息到env.properties,也可以自定义。
  4. 将itapm-annotations,itapm-maven-plugins,itapm-parser三个jar推送到私服(本地或者公司)
  5. 生成mvn install 该项目,将itapm-runner.jar(spring-boot的应用)部署在公司服务器,或者本地启动。

使用说明

  1. 引入itapm-annotations.jar到自己的java工程
  2. 配置itapm-maven-plugins到项目
  3. 在自己的java项目中使用注解 @Catagory @DubboApi @RestApi @ApiParam
  4. 通过maven命令打包即可。

itapm-maven-plugins配置:

   <profiles>
        <profile>
            <id>generate-doc</id>
            <build>
                <plugins>
                    <plugin>
                        <groupId>com.gitee.shxz130.itapm.maven</groupId>
                        <artifactId>itapm-maven-plugin</artifactId>
                        <version>1.0-SNAPSHOT</version>
                        <executions>
                            <execution>
                                <id>generate-doc</id>
                                <phase>install</phase>
                                <goals>
                                    <goal>generate-doc</goal>
                                </goals>
                            </execution>
                        </executions>
                        <configuration>
                            <systemEnName>系统英文名</systemEnName>
                            <systemChName>系统中文名</systemChName>
                            <docBaseUrl>{http://localhost:8080}/api/push.json</docBaseUrl><!-- 指定itapm应用地址-->
                            <docVersion>1.0.0</docVersion><!-- 文档版本号,不建议修改-->
                        </configuration>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>

项目截图

主页 接口明细页 json数据 测试功能显示

最后,欢迎加好友交流,一起学习共同进步

微信号

码云特技

  1. 使用 Readme_XXX.md 来支持不同的语言,例如 Readme_en.md, Readme_zh.md
  2. 码云官方博客 blog.gitee.com
  3. 你可以 https://gitee.com/explore 这个地址来了解码云上的优秀开源项目
  4. GVP 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目
  5. 码云官方提供的使用手册 https://gitee.com/help
  6. 码云封面人物是一档用来展示码云会员风采的栏目 https://gitee.com/gitee-stars/

intelligent-api-platform's People

Contributors

shxz130 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  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.