Automatic generation interface documentation tool – Use of Swagger, please stamp link juejin.cn/post/684490…
Tool to compare
|
Tools and Features |
Rap2 |
ShowDoc |
Swagger |
|
View the ease of use of interfaces |
View parameters, which is more intuitive Access address one, can view all products. |
View parameters, which is more intuitive Access address one, can view all products. |
Parameters are not intuitive, and some data types are not generic. If there are 10 items, there are 10 access addresses. |
|
Add interface speed |
Support JSON import |
1. You need to manually select the title – Secondary directory – Tertiary directory of the interface 2. Cannot support multiple layers of data (e.g. array in parameter) |
You need to add a keyword to each parameter |
|
Automatically update documents |
Does not support |
Does not support |
support You need to follow the specification, add code comments, and finally scan to generate documentation |
|
Online Interface testing |
support |
support |
support |
Other tools
Postman and Yapi.
Postman is the client. Interface sharing, limited number of users. You have to pay for more than one person.
Yapi’s website is yapi.demo.qunar.com. It is open source and supports local deployment.
supplement
Rap2’s platform is at rap2.taobao.org. Open source, supports this non – deployment.