Foreword
Development, interface documentation is very important, especially now that the front and rear end web developers are beginning to separate, and more need a good interface documentation.
It is up to how fast the interface documentation, calling example, mock it? If too much trouble, a lot of people do not want to write.
Today to introduce a very handy tool, easy document easydoc.xyz
Easy document is a professional interface management platform, he can easily write pretty professional api documentation, more importantly, can generate a key interface documentation, calling example, mock configuration, in one fell swoop into three, relaxed and happy.
Preview, watch online preview
How to generate a key
End Interface development, we usually need to be tested at the interface, the interface is ok to determine the
Easy document provides an online interface testing function, the key is after the test, easy document can according to your request and response parameters, a key generation interface documentation, and then can be a key to generate mock configured according to the document, you can also save the entire testing process is a example calls.
Such interface test is over, your documentation, samples, mock also have been.
Action figure demonstrates a key document generation
FIG example demonstrates movable generates a call
Add a call example, allows a better understanding of how other people call interface.
After you interface test, the entire request and response to a call parameter memory example
Example calls can also easily save testers test results Oh various situations, such as phone number logged in, login verification code and other different calls, different threshold values can be saved as an example of a call
A key generator configured mock
Server interfaces have not developed well, how do? Just need to interface documentation written, you can configure a key to generate mock you, the client can be developed, see figure below
The last document effects
The following is a preview of the final document, which is a green reptile call example, the bottle represents a mock, online watch preview
Reproduced in: https: //juejin.im/post/5cff70a36fb9a07eff007f25