1 Star 0 Fork 793

八块腹肌的阿明 / zyplayer-doc

forked from dromara / zyplayer-doc 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

zyplayer-doc

项目介绍

定位为所有文档的管理项目,swagger文档、dubbo文档、数据库文档、wiki、ElasticSearch文档....等,提供一整套的解决方案,为开发者服务,欢迎有想法的一起来写,给个Star鼓励下呗!(您的一个Star是快速迭代的动力源泉!) 欢迎加群讨论,QQ群号:466363173

体验地址:http://doc.zyplayer.com 需登录 账号:zyplayer 密码:123456 (未运行dubbo服务,不能体验dubbo文档调试)

各模块的详细使用文档地址,部署必看: http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb

软件架构

一、zyplayer-doc-core 一些核心、公用的类
二、zyplayer-doc-db 数据库文档

zyplayer-doc-db,具有数据库文档的查看、管理、导出等功能

三、zyplayer-doc-manage 可以单独部署的文档管理后台

后端使用spring-boot、mybatis-plus、springfox-swagger等框架,前端使用zuiVueelement-ui等框架

已集成三套优秀swagger文档前端:zyplayer-doc-swaggerswagger-bootstrap-uispringfox-swagger-ui

已集成本项目内的各子模块,可直接使用

四、zyplayer-doc-swagger 原swagger-mg-ui,swagger的UI及整套解决方案

具有 后端存储、代理请求、模拟返回、所有文档管理 等一系列原创功能,不止UI

五、zyplayer-doc-dubbo 将dubbo的文档在线化管理

支持zookeeper、nacos的注册中心文档获取,支持在线调试接口

六、zyplayer-doc-wiki wiki文档工具

支持文档创建、展示,文件上传、下载,空间隔离,开放文档访问等

七、zyplayer-doc-grpc grpc文档工具

用比较变态的方式实现了grpc的文档和在线调试功能,通过http的方式来请求grpc的接口

默认未开启此功能,如需使用需要在zyplayer-doc-manage项目中开启@EnableDocGrpc注解

八、zyplayer-doc-es ElasticSearch文档工具

支持ElasticSearch的文档查看和执行DSL查询的功能

运行方式

  1. 创建数据库:zyplayer_doc_manage,执行脚本:zyplayer_doc_manage.1.0.4.sql

  2. 修改zyplayer-doc-manage项目的application.yml配置文件里面的数据库账号密码

  3. 启动zyplayer-doc-manage项目,访问地址:http://127.0.0.1:8083/zyplayer-doc-manage/

模块介绍

一、zyplayer-doc-swagger
  1. zyplayer-doc-swagger->文档管理->文档地址管理 页可以管理任意地址的文档,在集成的三套UI中都可以直接查看和调试这里配置的文档,不用对UI做任何调整,只要标准的UI集成进来也可以直接用

  2. 文档展示配置,自动填充请求参数:可配置填充级别,强制重写域名:文档在本地想调试线上接口的好帮手,自动保存请求参数:不用每次输入

  3. 可配置全局参数,放在header或param里的

  4. 可对调试数据进行管理

  5. 模拟返回:前端自行调试接口的好帮手

  6. 私人强迫症级定制化文档展示,清晰明了,参数支持批量编辑,每一条线的间距都考量了半天,支持文件上传的调试,需要指定dataType = FileMultipartFile,例:

@ApiImplicitParam(name = "file", value = "文件", dataType = "File", allowMultiple = true)

  1. 后端代理请求,后端存储,不会存在任何跨域问题
二、zyplayer-doc-db
  1. 支持Mysql、SQLserver的数据库表、字段文档查看修改,导出,展示关系图等功能

  2. 支持多数据源,在zyplayer-doc-manage -> application.yml -> zyplayer.doc.db.dbConfigList 处配置多个数据库连接即可

三、zyplayer-doc-dubbo
  1. zyplayer-doc-manage -> application.yml -> zyplayer.dubbo.zookeeper.url 配置zookeeper地址

  2. zyplayer-doc-manage -> application.yml -> zyplayer.dubbo.nacos.url 配置nacos服务地址

  3. 默认找zookeeper,未配置再找nacos的配置

  4. 支持文档查找、文档编辑、在线调试接口

  5. 自动获取参数列表需要指定的类存在,所以请在 pom.xml -> dependencies 最后加上服务所在的包,后端才能通过Class.forName("xx");来找到参数列表,减少录入成本

  6. 数组或List参数,调试参数录入格式例:[1,2] ,后端通过JSON工具转成指定类型,有不支持的类型时欢迎反馈

四、zyplayer-doc-manage
  1. 整合了上面两个功能到此项目,较少熟悉成本,git clone下来即可运行

  2. 具有简单的权限管理人员管理功能

  3. 使用最新的一些技术框架,很简单,初学者拿来学习也是很不错的

更多详细的使用部署文档:http://doc.zyplayer.com/zyplayer-doc-manage/open-wiki.html?pageId=1&space=23f3f59a60824d21af9f7c3bbc9bc3cb

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: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and 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 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 2018 暮光:城中城 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.

简介

定位为所有文档的管理项目,swagger文档、dubbo文档、wiki文档、grpc文档、数据库文档、elasticsearch文档...等,提供一整套的解决方案,基础功能已比较完善,欢迎使用和加入开发 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/yuebanriyue/zyplayer-doc.git
git@gitee.com:yuebanriyue/zyplayer-doc.git
yuebanriyue
zyplayer-doc
zyplayer-doc
master

搜索帮助