您能否使用swagger记录其他人开发的API?

时间:2017-12-05 18:15:31

标签: javascript java api swagger swagger-ui

我是swagger.io的新手。我有一堆由一个不再与我合作的团队开发的API。所以这些API没有被它们正确记录。所以,我正在考虑使用招摇和正确记录它们。

但问题是,是否可以用招摇文件来记录这些API?

如果是,怎么样? 如果不是,我还有其他工具/框架吗?

2 个答案:

答案 0 :(得分:2)

是的,您可以在Swagger Editor中手动为API编写OpenAPI(fka Swagger)定义(.yaml或.json),然后使用Swagger UI显示API文档。但是,在这种情况下,OpenAPI定义与API实现不同步(即,未链接到源代码),因此如果实现更改,则需要手动更新OpenAPI定义。

答案 1 :(得分:-1)

不要大摇大摆,但WireMock会让观察并将API记录为黑盒子。

http://wiremock.org/docs/record-playback/