好的API文档不是随便就能够生成的。它须要明确的领导计划、团队统一的致力、严格的用户评审以及在API的整个生命周期中保护文档。如果须要编写的好的API文档则应该包含：
必要的组件。残缺的文档通常蕴含有参数阐明、谬误音讯、响应信息、示例，以及全面的更改日志的局部。一些API文档还包含一系列指南，这些指南提供了API应用和用例的具体示例。
理解指标用户。为指标用户量身定制API文档。如果该文档是为老手开发人员筹备的，须要专一于教程，示例和指南。如果文档是为有教训的开发人员筹备的，则须要构建具体阐明语法，参数，自变量和响应详细信息的参考资料。
调配文档职责。开发团队的一名或多名成员应开发和保护API文档，以确保文档的准确性，清晰性和易用性。好的API文档工具能够从单个人的创立、增加正文、示例和其余根本组件中获益。能够将此职责交给能使文档易于拜访并且与其余部门（例如产品开发，市场）有单干的人员。
API文档的覆盖范围。语法参考、示例和指南创立了API文档的技术外围。例如，对于每个调用或申请，语法援用的长度应该大致相同，并且蕴含雷同的元素。如果一个性能的详细信息超过五页，而另一个性能只有半页，则文档可能不残缺。相似地，留神那些只显示一小部分API调用的示例，或者疏忽了解决响应（如谬误音讯）的示例。
将文档带入开发过程。如果将API文档蕴含在迭代开发过程中，通常会更好。对于每个新版本，文档都应进行相应的更新和更改。将API文档作为预先思考或独自的工作来解决会导致API文档不全面。创立全面的API文档须要破费工夫和精力，然而值得进行投资。短少、不残缺或不正确的API文档可能会使API治理变得艰难。
演示工具：Eolinker
应用地址：www.eolinker.com