克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

auto-api

介绍

在前后端分离设计开发流行的今天,多数公司的开发流程都有以下问题。 1、后台开发人员每次新增api字段,新增api接口需要手工维护apidoc。 2、需要集成第三方api框架如Swagger大量自定义注解,或基于javaDoc注释解析的第三方框架。 3、前后端开发前中期联调困难,前端联调非常依赖后端接口代码开发顺序质量与完成进度。 ,后台开发人员依赖前端页面进行流程测试,或花费较大时间定义json数据验证。 4、依赖Postman工具,每次api变更,新增都需要进行维护工作,没有自动化集成项目api。 5、接口自动化测试较为耗时,测试人员需要根据apidoc或者页面流程抓取接口进行开发。 6、由接口自动化测试编排功能提供,快速融入项目,快速了解模块流程。 系统功能说明 1、支持OpenApi3.0规范,零侵入式的任意实体VO自定义泛型自动化api推导功能,自动集成Swagger注解、校验注解。 2、支持自定义的api数据字典字段定义规则如:商品类型(1-单品,2-组合),自动解析字段规则值,后端支持根据自定义规则自动化mock数据功能,支持前端自定义mock接口数据功能,解耦前后端联调依赖。 3、自动化接口api支持自动集成推送Yapi、Torna项目显示后台管理功能。 4、根据自动化api实现web postman功能。 5、实现根据自动化api任意编排自动化测试功能,提供自动化测试接口报错入参,日志等功能。 6、提供java网关功能。限流、黑白名单、api管理等功能。 7、提供多个api接口数据marge功能。 8、各业务系统所有bean依赖关系查看,提供系统公共组件、代码优化、业务流程优化时影响范围检索功能。

软件架构

软件架构说明 使用SpringBoot,SpringCloud,java反射,MybatisPlus,Mysql。 项目包含模块功能 api-admin:api管理服务平台,api版本管理,通过对外暴露saveApiList服务保存更新获取的自动化api集合,Yapi、Torna接口推送功能。 api-annotation:自定义注解功能项目。 api-common:通用功能实现包含Dozer对象转换工具、Json转换工具等。 api-core:核心功能实现,运用了工厂、模板方法、建造者、责任链递归泛型解析VO、Spring RestController、泛型解析工具等多种工具类,提供解析RestController入参、出参ESTful API 接口规范功能,目前对接了Yapi、Torna接口推送。 api-framework:通用组件公共抽象模块。 api-web:通用web配置。 api-gateway: java网关功能。 api-mapping:通过ApplicationReadyEvent容器初始化完成事件,初始化解析Spring Controller。 api-openapi:开放平台openapi功能。 api-rpc: 通过SPI配置支持auto-api-spring-starter 集成SpringBoot功能、Http接入功能。 api-service api服务治理,流量监控 api-history 服务调用历史 开发中 api-limit api服务限流熔断降级 api-test api服务自动化测试 开发中 api-auth api服务授权校验,应用调用关系管理

安装教程

  1. 安装auto_api.sql

  2. 运行api-admin

  3. 通过api-rpc http方式引入jar解析引擎 1、新增 com.auto.api.mapping.listener.MappingInitListener com.auto.api.mapping.filter.MockFilter bean配置 2. application.properties 资源文件中引入 #是否进行api解析 auto.api.mapping=true #是否使用mock数据 auto.api.mock=false 3. 启动类scanBasePackages 新增"com.auto.api"包扫描路径

  4. 通过api-rpc auto-api-spring-starter方式引入jar解析引擎

    1. application.properties 资源文件中引入 #是否进行api解析 auto.api.mapping=true #是否使用mock数据 auto.api.mock=false
    2. 启动类scanBasePackages 新增"com.auto.api"包扫描路径

使用说明

  1. 对接fork Tarna 地址: https://gitee.com/legouw/torna 2、前端使用需要先运行Torna,创建平台,创建项目,在module表中定义好torna与aoto-api的对接token 3、运行项目,之后所有api维护操作就跟随代码自动维护更新了。 4、对接Yapi 在api_info 表param_api_json、result_api_json 字段用于对接入参与出参json,直接拷贝就可以在Yapi平台使用

qq技术交流群:893304387

欢迎贡献代码,开发不易,求star一下啊

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request

特技

  1. 使用 Readme_XXX.md 来支持不同的语言,例如 Readme_en.md, Readme_zh.md
  2. Gitee 官方博客 blog.gitee.com
  3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
  4. GVP 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目
  5. Gitee 官方提供的使用手册 https://gitee.com/help
  6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

一、背景 通常的文档生成工具,都需要开发人员编写注解或注释,代码入侵太强,而且费事,我希望api工具具有如下功能: 1.自动解析代码,根据代码生成api接口,如果有注释就自动扫描注释(自动集成swagger),没有就以代码为准,生成的api接口如果有不合理的地方,可以在页面进行修改,利用web页面的表单编辑修改要比在代码里处理方便直观。 2.Api接口调整自动完成维护,自动通知开发测试改动部分内容(集成邮件或极光推送等)。 3.自动按项目模块结构归(移植对接yapi项目目录结构),可自由调整目录结构。 4.开发测试api自动集成登录验证,直接输入参数请求调试接口,支持默认数据字典数据填充,前后台都抛弃PostMan等第三方测试工具。 5.Api接口确定后前后端开发分离,... 展开 收起
Java 等 3 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化