在Qmino(创建Miredot的公司)中,我们编写了数百种REST API。我们进行设计和重新设计,直到我们的API使用起来很愉快为止。文档是API的用户界面。我们坚信这一点。真正展示好的API的唯一方法是为开发人员提供漂亮而正确的文档。这就是为什么我们对文档非常谨慎。我们甚至让缺乏Javadoc的开发失败,代码审查包括检查文档。紧接着,如果Miredot检测到REST API文档中的任何错误,我们将使构建失败。Miredot几年前,我们确实找不到任何适用于Java的REST API文档工具。我们想要的东西需要任何现有的工件,例如Javadoc,Java源代码,注释等等。可以理解我们使用的框架的东西,例如jax-rs,spring和jackson,并将其变成漂亮的东西。我们的API使用者喜欢使用的东西。这正是我们与Miredot不断追求的目标。而且,到目前为止,我们对结果感到非常自豪!