open-source-sharing / rest-doc Goto Github PK

RESTdoc Project is a document software that improves research and development efficiency. It integrates testing and document generation. It can quickly import the application's Http API or RPC API to quickly generate documents.

License: Apache License 2.0

Kotlin 74.99% Java 24.95% Python 0.02% Dockerfile 0.02% Shell 0.02%

service-mesh microservice web kotlin restdoc doc springboot

rest-doc's People

Contributors

Stargazers

Watchers

Forkers

wangyi1989 gaocaiting

rest-doc's Issues

复合型应用会跟console端建立多个长连接

如果一个应用既属于RESTweb又属于dubbo，在应用启动的过程中会跟console端建立两个长连接(应该属于同一个)

在生成codesample时，使用正则去掉html标签/在更新文档时字段赋值出现问题

优化API导入过程

不论是dubbo应用还是http应用，导入API功能按钮放在导航栏，并且点击导入之后，显示接入客户端的API列表

redis序列化问题

redis序列化对象会转换为一个HashMap对象而非一个对象

文档编辑流程的参数类型检测

1 在Http API document的编辑场景下，需要检测 '示例值' 的类型
2 在Dubbo API document的编辑场景下，需要检测 '示例值' 的类型

restdoc.web.controller.obj.VOKt#getROOT_NAV全局变量BUG

restdoc.web.controller.obj.VOKt#getROOT_NAV属于全局变量不可以在其他地方修改

project算法错误测试如下

REST-doc/restdoc-web/src/test/kotlin/restdoc/web/util/JsonProjectorTest.java

Line 26 in fc4a0c1

public class JsonProjectorTest {

1.0.RELEASE优化计划

单独增加queryParam的UI表单/UI字段说明表格；
增加调试记录的保存；
增加从调试记录中导入测试数据，生成文档；
增加文档的复制功能；
增加响应字段的示例值的自动补齐；
增加restdoc-console的数据库备份功能；
增加文档的word导出，和markdown/adoc的生成;

增加对Http API响应类型的解析问题

Http Test log对应一个响应类型
1 JSON (application/json)
2 XML(application/xml)
3 File （application/octet-stream）

Java saxreader技术解析xml解析与反解析需求

术语：xml解析为一个带有path路径的平级数据称为projector
一个带有path的平级数据解析为xml称为deProjector

xml需求示例

<student>
	<name id="001">张三</name>
	<sex>男</sex>
	<age>20</age>
</student>

projector的输入为上述xml字符串，输出如下：

student.name=张三
student.sex=男
student.age=20

deProjector输入为

student.name=张三
student.sex=男
student.age=20

输出为下

<student>
	<name id="001">张三</name>
	<sex>男</sex>
	<age>20</age>
</student>

文档保存过程流程优化

保存文档时再提示输入API所操作的目标资源；
在调试界面去掉所有的字段备注；
在调试界面去掉所有字段的类型显示（自动推断显示，借鉴IDEA的debug模式）；
所有的历史数据保存做算法分析，分析用户输入的某些字段某些url地址输入的某些资源名称 API名称，以达到可以快速补全开发者所将要填写的文本（使用文本相似度分析）；
增加REST doc的建议功能，开发者使用期间，REST doc分析资源与操作之间的关系，并且给出合理的代码设计的方案；
’REST doc API调试控制台优化，每次提交Http Task分阶段显示 connecting connected operation returning completed等阶段，提升调试体验；

console端重启后，内存中的客户端会多出一个

console端重启后，内存中的客户端会多出一，没有及时销毁内存对象

项目API在API导入时ID需要将ProjectId参数加入进去，否则引起多个项目引用一个目录或者文档

如何调整API文档的所在目录

mongodb4.2.0bug

docker-compose.yml内容如下，只有版本调整成4.0.10才会初始化用户密码

version: '3.7' services: redis: image: 'redis:4-alpine' command: redis-server --requirepass overman@@2020 --bind 0.0.0.0 ports: - 6377:6377 mongodb : image: mongo:4.0.10 environment: MONGO_INITDB_ROOT_USERNAME: front_biz MONGO_INITDB_ROOT_PASSWORD: qmbxfrontbizStorage MONGO_INITDB_DATABASE: non_standard command: [--auth] restart: always ports: - 27017:27017 volumes: - mongodb_data_container:/data/db - ./mongo-init.js:/docker-entrypoint-initdb.d/mongo-init.js:ro restdoc-console: image: registry.cn-beijing.aliyuncs.com/opensource-sharing/restdoc-console:1.0.RELEASE ports: - 8432:8432 depends_on: - mongodb - redis volumes: mongodb_data_container:

REST-doc更名为SmartDoc

restdoc-client无法访问restdoc-console的容器内部

从Dubbo应用导入API需要做去重

1 id根据API的部分特征来进行Hash获取

功能完善

请求头去重
api文档页面去掉无参数的体

关于json的project算法出现部分数据无法映射

1.0 preview版本开发计划步骤

1 完成springcloud的后台调试和api导入功能。
2 解决dubbo http api导入功能bug。
3 解决http调试提示错误的问题。
4 增加kotlin，JavaScript（ajax 和axio），go语言sample，
5 解决curl test sample出现的一串英文字符。
6 增加鉴权登陆（后台需要登录，前端开发人员访问API文档需要访问密码）
7 提供maven仓库中心的客户端sdk下载。
8 提供docker compose一键安装文档。
9 重写readme/架构图。包括英文版本。
10 提供RESTdoc官网。关联github和gitee。
11 申请购买RESTdoc域名。
12 提供体验API文档功能云端体验。
13 进入公众号推广。