发布于 : Apr 03, 2024
Apr 2024
评估
目前被广泛使用的 REST APIs 的一个特点是它们的合约会被彻底地记录在案。开发者更倾向于采纳和使用那些以结构化、有组织的方式准确描述其行为和语法的 API。随着合约的发展,保持这些文档的更新可能既耗时又容易被忽视。Fern Docs 通过减少编写和维护 API 文档的劳动强度来帮助解决这个问题。Fern 可以自动从规范文件生成一个具有吸引力、可用文档的网站,这个文件能与 API 代码一起版本化。我们对这个产品的初步印象是积极的,不过 Fern 要求用户在一个专有配置文件中维护 API 信息,尽管它提供了一种将 OpenAPI 规范转换为其自己的配置格式的方法,但我们更期待一个能够直接从带注释的源代码生成文档的工具。