javaapi和源码-restapi-preprocessor-java:RESTAPI框架的源代码解析器和预处理器

java api和源码restapi预处理器java Restful Web服务有很多文档框架可供选择：swagger.io，apidocjs.com等。 之所以认为这些框架是因为它们通过执行一种格式来指导用户，从中可以用HTML生成API层的视图。 这种近视解决方案立即带来必须处理API的两个视图（至少）的问题。 第一个是由源代码表示的视图，第二个是框架的视图。 我们认为，这些框架的做法从根本上是错误的。 API应该有一个真实的来源，并且应该是源代码。 由于后者同时捕获了API层的规范和实现，因此可以提取规范。 但是，这样做不是相反的：例如，从一个摇摇欲坠的规范生成源代码仍然需要开发人员粘贴实现。 每次规范更改时都这样做不是计算机科学。 但是，为了避免重新发明轮子，我们可以将swagger等人视为不完整的解决方案，并在其前面加上预处理器层，该预处理器层将源代码映射到它们各自的输入。 在这里停止我们可以将文档分为两类：硬编码与生成 例如： /** * @apiDescription text */ 应该输入（硬编码）。 在Java上下文中，它可以兼用作其注释方法的javadoc描述。